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

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.email:
string
The new email 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.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 }}