Update tags

PATCH/api/v1/contacts/{id}/tags

This endpoint allows you to perform an update only tags 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

tagsarray[string]required
Associated tags with this contact. (an array of tags'names and will create new tag if not exists)
actionTypestringrequired
MERGE: Appends new tags to the existing tags, keeping all current tags; REPLACE: Discards existing tags and uses only the new tags.

Allowed values:"MERGE", "REPLACE"

Responses

200

statusstringrequired
messagestringrequired
datanullrequired

400

Bad Request

messagearray[string]required
errorstringrequired
statusCodeintegerrequired

Request

curl -X PATCH "https://apigw.klinkcx.com/api/v1/contacts/{id}/tags" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
  "actionType": "MERGE",
  "tags": [
    "vip",
    "new"
  ]
}'

Response

{
  "status": "success",
  "message": "Contact tags updated successfully",
  "data": null
}