{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/contact_details","auth":"required","examples":{"codes":[]},"method":"post","params":[{"name":"auth_token","type":"string","default":"YOUR KEY","desc":"Your API key","required":true,"in":"body","ref":"","_id":"560455090c78b00d0039b18f"},{"name":"contact_detail.name","type":"string","default":"John Doe","desc":"Name of the contact","required":true,"in":"body","ref":"","_id":"560455090c78b00d0039b18e"},{"name":"contact_detail.contact_detail_type","type":"string","default":"Contractor","desc":"The role you want to assign to this contact. If the role is not yet existing in your account it will be created.","required":true,"in":"body","ref":"","_id":"560455090c78b00d0039b18d"},{"name":"contact_detail.secondary_type","type":"string","default":"Interior Work","desc":"","required":false,"in":"body","ref":"","_id":"56165b18a6767c0d001669e0"},{"name":"contact_detail.email","type":"string","default":"john:::at:::due.com","desc":"","required":false,"in":"body","ref":"","_id":"56165b2921e9110d00780322"},{"name":"contact_detail.site_ids","type":"object","default":"[1, 2]","desc":"Array of all the site ID's you want to link this contact to","required":false,"in":"body","ref":"","_id":"561659b21651730d0050493f"},{"name":"contact_detail.site_uuids","type":"object","default":"[uuid1, uuid2]","desc":"Array of all the site UUID's you want to link this contact to","required":false,"in":"body","ref":"","_id":"561659b21651730d0050493e"},{"name":"contact_detail.site_client_internal_unique_ids","type":"array_object","default":"[client_internal_unique_id1, client_internal_unique_id2]","desc":"Array of all the site client_internal_unique_ids you want to link this contact to. Use it instead the list of site ids.","required":false,"in":"body","ref":"","_id":"59c39254b2b45c0010b7b87e"},{"name":"contact_detail.cellphone_number","type":"string","default":"123.4.5.67890","desc":"Phone number","required":false,"in":"body","ref":"","_id":"56165b18a6767c0d001669e2"},{"name":"contact_detail.company_name","type":"string","default":"Microsoft INC","desc":"","required":false,"in":"body","ref":"","_id":"56165b18a6767c0d001669e1"},{"name":"contact_detail.additional_info","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"56165b18a6767c0d001669df"},{"name":"contact_detail.external_id","type":"string","default":"","desc":"Your external ID. Only applicable if working with Excel upload for importing contacts","required":false,"in":"body","ref":"","_id":"56165b18a6767c0d001669de"},{"name":"contact_detail.fax_number","type":"string","default":"123 456","desc":"Fax","required":false,"in":"body","ref":"","_id":"5c40766d9c95f700513cac86"},{"name":"contact_detail.address","type":"string","default":"Main Street 33, 1001 New York","desc":"full address","required":false,"in":"body","ref":"","_id":"5c4076b76681f2006334e869"}],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Creating a contact","type":"endpoint","slug":"creating-a-contact","excerpt":"","body":"","updates":[],"order":12,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"560455090c78b00d0039b18b","editedParams":true,"editedParams2":true,"__v":15,"parentDoc":null,"project":"54870ea47810260b001c36ab","user":"54870d54f907080b00fc49cd","githubsync":"","createdAt":"2015-09-24T19:54:49.298Z","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},"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"},"updatedAt":"2019-07-08T08:09:00.208Z"}

postCreating a contact


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

auth_token:
required
stringYOUR KEY
Your API key
contact_detail.name:
required
stringJohn Doe
Name of the contact
contact_detail.contact_detail_type:
required
stringContractor
The role you want to assign to this contact. If the role is not yet existing in your account it will be created.
contact_detail.secondary_type:
stringInterior Work
contact_detail.email:
contact_detail.site_ids:
object[1, 2]
Array of all the site ID's you want to link this contact to
contact_detail.site_uuids:
object[uuid1, uuid2]
Array of all the site UUID's you want to link this contact to
contact_detail.site_client_internal_unique_ids:
array of objects[client_internal_unique_id1, client_internal_unique_id2]
Array of all the site client_internal_unique_ids you want to link this contact to. Use it instead the list of site ids.
contact_detail.cellphone_number:
string123.4.5.67890
Phone number
contact_detail.company_name:
stringMicrosoft INC
contact_detail.additional_info:
string
contact_detail.external_id:
string
Your external ID. Only applicable if working with Excel upload for importing contacts
contact_detail.fax_number:
string123 456
Fax
contact_detail.address:
stringMain Street 33, 1001 New York
full address

User Information

Try It Out

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