Update

PATCH/api/v1/contacts/{id}

This endpoint allows you to perform an update on a contact.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Path Params

idstringrequired
Contact ID

Example:

Body Paramsapplication/json

usernamestringrequired
The username for the contact.
emailarray[object]required
An array of objects which has email and isPrimary as keys. (can be provided as empty array). Provide empty array to update all fields you have included in request body.
Child attributes
- emailstringrequired
- isPrimarybooleanrequired
phonearray[object]required
An array of objects which has phone and isPrimary as keys. (can be provided as empty array). Provide empty array to update all fields you have included in request body.
Child attributes
- phonestringrequired
- isPrimarybooleanrequired
companystringoptional
Name of the company associated with the contact.
tagsarray[string]optional
Associated tags with this contact. (an array of tags'names and will create new tag if not exists)
channelstringoptional
The channel where received the contact. Example: phone, email, viber, etc. (accept only name of the channel you have in app).
addressstringoptional
Address of the contact.
notesstringoptional
The contact's note that saved by agent.
customFieldsobjectoptional
A key value pair object with name of custom field as key.

Responses

200

statusstringrequired
messagestringrequired
datanullrequired

Request

curl -X PATCH "https://apigw.klinkcx.com/api/v1/contacts/{id}" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "FrankMcCallister",
  "email": [],
  "phone": [
    {
      "phone": "1-800-759-3000",
      "isPrimary": true
    }
  ]
}'

Response

{
  "status": "success",
  "message": "updating contact",
  "data": null
}