{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/contact_detail","auth":"required","params":[{"name":"auth_token","type":"string","default":"","desc":"Your API key","required":true,"in":"body","ref":"","_id":"56176873a410c90d00c612ac"},{"name":"id","type":"int","default":"","desc":"The contact detail ID. Use this, or the UUID.","required":false,"in":"body","ref":"","_id":"5617691f9d753b0d00343d59"},{"name":"uuid","type":"string","default":"","desc":"The contact detail UUID. Use this, or the ID","required":false,"in":"body","ref":"","_id":"5617691f9d753b0d00343d58"},{"name":"external_id","type":"string","default":"","desc":"The external ID of your contact. Can be used instead of ID or UUID","required":false,"in":"body","ref":"","_id":"561769b97f74330d00dfd79e"},{"name":"contact_detail.name","type":"string","default":"","desc":"The new name you want to assign. Leave empty if you don't want to change.","required":false,"in":"body","ref":"","_id":"5617691f9d753b0d00343d57"},{"name":"contact_detail.site_ids","type":"array_string","default":"[1, 2]","desc":"The new set of sites (IDs) you want to assign. Leave empty if you don't want to change.","required":false,"in":"body","ref":"","_id":"5617691f9d753b0d00343d56"},{"name":"contact_detail.site_uuids","type":"array_string","default":"[uuid1, uuid2]","desc":"The new set of sites (UUIDs) you want to assign. Leave empty if you don't want to change.","required":false,"in":"body","ref":"","_id":"56176957488a011700dd2d29"},{"name":"contact_detail.site_client_internal_unique_ids","type":"array_string","default":"[client_internal_unique_id1,client_internal_unique_id2]","desc":"The list of client_internal_unique_ids you want to assign. Use this instad of the list of sites ids.","required":false,"in":"body","ref":"","_id":"59c394e912b8c2001c22be0b"},{"name":"contact_detail.contact_detail_type","type":"string","default":"","desc":"The new role you want to assign. Leave empty if you don't want to change.","required":false,"in":"body","ref":"","_id":"5ece6dc424493f0018da8ca0"},{"name":"contact_detail.secondary_type","type":"string","default":"","desc":"The new subrole you want to assign. Leave empty if you don't want to change.","required":false,"in":"body","ref":"","_id":"561769b97f74330d00dfd7a0"},{"name":"contact_detail.email","type":"string","default":"","desc":"The new email you want to assign. Leave empty if you don't want to change.","required":false,"in":"body","ref":"","_id":"561769b97f74330d00dfd7a1"},{"name":"contact_detail.cellphone_number","type":"string","default":"","desc":"The new phone you want to assign. Leave empty if you don't want to change.","required":false,"in":"body","ref":"","_id":"561769b97f74330d00dfd79f"},{"name":"contact_detail.additional_info","type":"string","default":"","desc":"The new additional info you want to assign. Leave empty if you don't want to change.","required":false,"in":"body","ref":"","_id":"561769b97f74330d00dfd79d"},{"name":"contact_detail.company_name","type":"string","default":"","desc":"The new company name you want to assign. Leave empty if you don't want to change.","required":false,"in":"body","ref":"","_id":"561769c99d753b0d00343d5b"},{"name":"contact_detail.fax_number","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5c4076e27ba483001f1b8d30"},{"name":"contact_detail.address","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5c4076e27ba483001f1b8d2f"}],"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"put"},"next":{"description":"","pages":[]},"title":"Update a contact","type":"endpoint","slug":"update-a-contact","excerpt":"","body":"","updates":[],"order":13,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56176873a410c90d00c612aa","category":{"sync":{"isSync":false,"url":""},"pages":["558a6e098d30cb2300873e1a","558a6e88dbe5b63700f8d201","558a6e9275eaf50d004e4bfa","558a6e9a8d30cb2300873e1c","558a79f2dbe5b63700f8d23f","5592abfb6bf22f170075b823","55a65e4580c8a30d00b32618","55ba22f804775a2f006280aa","55ba2648b3612925009d66f0","56045138e416560d00fa6484","560452e4e5102a0d0070f965","560455090c78b00d0039b18b","56176873a410c90d00c612aa","56176a014d9e4a17002a0e05","5628d38e0653060d00a2f7d9","5628d5d748742a0d0047456d","56a669cffb12a40d006c4826"],"title":"API","slug":"api","order":5,"from_sync":false,"reference":true,"_id":"558a6dd975eaf50d004e4bf5","version":"54870ea57810260b001c36ae","__v":17,"createdAt":"2015-06-24T08:44:09.019Z","project":"54870ea47810260b001c36ab"},"__v":11,"editedParams":true,"githubsync":"","editedParams2":true,"project":"54870ea47810260b001c36ab","user":"54870d54f907080b00fc49cd","createdAt":"2015-10-09T07:10:43.024Z","parentDoc":null,"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54870ea57810260b001c36af","5487116f7810260b001c36b5","548711797810260b001c36b6","548711807810260b001c36b7","548713127810260b001c36bd","548713247810260b001c36be","548713aa7810260b001c36c0","548713c2f907080b00fc49d5","548713eef907080b00fc49d9","54871a0db3441a1f00f20d78","54871b15b3441a1f00f20d7e","54871cbeb3441a1f00f20d87","548817fac178b40b00aa2eec","558a6dd975eaf50d004e4bf5","558a6e37dbe5b63700f8d1fe","56795d8c07bf6a0d0083ee9e","583e9d764ced340f00b05a5c","5d1f3f70b4648901728803b7","5d22f7db4c9e14005111e34f","5d22fa62a541770012a07464"],"_id":"54870ea57810260b001c36ae","createdAt":"2014-12-09T15:00:53.237Z","project":"54870ea47810260b001c36ab","releaseDate":"2014-12-09T15:00:53.237Z","__v":20},"updatedAt":"2019-07-08T08:09:00.208Z"}

putUpdate a contact


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

auth_token:
required
string
Your API key
id:
integer
The contact detail ID. Use this, or the UUID.
uuid:
string
The contact detail UUID. Use this, or the ID
external_id:
string
The external ID of your contact. Can be used instead of ID or UUID
contact_detail.name:
string
The new name you want to assign. Leave empty if you don't want to change.
contact_detail.site_ids:
array of strings[1, 2]
The new set of sites (IDs) you want to assign. Leave empty if you don't want to change.
contact_detail.site_uuids:
array of strings[uuid1, uuid2]
The new set of sites (UUIDs) you want to assign. Leave empty if you don't want to change.
contact_detail.site_client_internal_unique_ids:
array of strings[client_internal_unique_id1,client_internal_unique_id2]
The list of client_internal_unique_ids you want to assign. Use this instad of the list of sites ids.
contact_detail.contact_detail_type:
string
The new role you want to assign. Leave empty if you don't want to change.
contact_detail.secondary_type:
string
The new subrole you want to assign. Leave empty if you don't want to change.
contact_detail.email:
string
The new email you want to assign. Leave empty if you don't want to change.
contact_detail.cellphone_number:
string
The new phone you want to assign. Leave empty if you don't want to change.
contact_detail.additional_info:
string
The new additional info you want to assign. Leave empty if you don't want to change.
contact_detail.company_name:
string
The new company name you want to assign. Leave empty if you don't want to change.
contact_detail.fax_number:
string
contact_detail.address:
string

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}