Create or update a contact

Creates the contact if it does not exist, otherwise updates it. The match is made on phoneNumber first, then email.

customFields are addressed by customFieldId; get the ids from List custom fields. assignedUsers takes the login phone numbers of your team members.

PUT

https://api.zacx.io/v1/contact/upsert

View as Markdown

Authorisation

bearerAuthHTTPrequired

Request bodyJSON

nameoptionalstring
Example: "John Doe"
emailoptionalstring
format: email
Example: "[email protected]"
phoneNumberoptionalstring
Phone number with country code. A leading + is accepted.

Example: "+11234567890"
customFieldsoptionalarray ofobject
2 properties
- customFieldIdstringrequired
  Id from List custom fields.
  
  format: uuid
- valuestringrequired
tagsoptionalarray ofstring
Tag names. Must already exist in the workspace.
assignedUsersoptionalarray ofstring
Login phone numbers of team members to assign.

Returns

200

The contact after the write.

JSON

statusstringrequired
dataobjectrequired
6 properties
- nameoptionalstring
- phoneNumberoptionalstring
- emailoptionalstring
  format: email
- customFieldsoptionalarray ofobject
  2 properties
  nameoptionalstring
  Example: "test field"
  valueoptionalstring
  Example: "custom field value"
- tagsoptionalarray ofstring
- assignedUsersoptionalarray ofstring
  Display names of the assigned users.

400

One or more parameters are missing or invalid.

JSON

statusstringrequired
codestringrequired
Stable machine-readable error code.
messagestringrequired
Human-readable explanation.

curl --request PUT \ --url https://api.zacx.io/v1/contact/upsert \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "John Doe", "email": "[email protected]", "phoneNumber": "+11234567890", "customFields": [ { "customFieldId": "7149ce0d-616c-46ca-8e09-cd00129fe947", "value": "field value 1" }, { "customFieldId": "f6a3b468-3678-4c4d-bdd9-724e9f4c9fa9", "value": "field value 2" } ], "tags": [ "VIP", "Premium" ], "assignedUsers": [ "919100110151", "919100110152" ] } '

{ "status": "success", "data": { "name": "John Doe", "phoneNumber": "11234567890", "email": "[email protected]", "customFields": [ { "name": "Test Field", "value": "field value 1" }, { "name": "Custom Field 2", "value": "field value 2" } ], "tags": [ "VIP", "Premium" ], "assignedUsers": [ "User 1", "User 2" ] } }