Remove Tags from a Contact

DELETE/v1/contacts/{identifier}/tags

Removes one or more tags from a contact. Tag IDs that are not currently assigned are ignored.

Path Parameters

identifierstring required

Contact ULID, email address, or E.164 phone number. Email addresses in paths should be URL-encoded (%40 for @).

Example:ulid: 01kptye62pxs8pp0xkh6d5vxz2

Body

tag_idsarray[string]•One or more tag ULIDs belonging to the workspace required

Example:[ "01JABC1234567890ABCDEFGH" ]

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required

Example:200

messagestring required

Example:OK

detailsobject required

dataobject required

tagsarray[object] required

idstring•Tag ULID

namestring

colorstring or null

descriptionstring or null

metaobject

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4
5
6
7
8
9
10

curl --request DELETE \
  --url "https://api-preprod.bevatelcloud.com/v1/contacts/{identifier}/tags" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json" \
  --data '{
  "tag_ids": [
    "01JABC1234567890ABCDEFGHJK",
    "01JXYZ1234567890ABCDEFGHJK"
  ]
}'

Response Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  "success_code": 200,
  "message": "OK",
  "details": {},
  "data": {
    "tags": [
      {
        "id": "string",
        "name": "string",
        "color": "string",
        "description": "string"
      }
    ]
  },
  "meta": {}
}