Skip to main content
PATCH
Rename a contact tag

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Path Parameters

tagId
string
required

The contact tag id.

Example:

"152"

Body

application/json
name
string
required

1 to 60 characters once cleaned up: emojis and other characters that take 4 bytes in UTF-8, and control characters such as line breaks and tabs, become a space; repeated whitespace becomes one space; and spaces at the start and end are removed.

Required string length: 1 - 60

Response

The renamed tag.

id
string
required
Example:

"123"

name
string
required

Unique in your account, ignoring case.

Maximum string length: 60
Example:

"vip"

type
enum<string>
required
Available options:
contact,
integration
integrationName
string | null
required

The integration that owns an integration tag.

Example:

"hubspot"

readOnly
boolean
required

true when this API cannot add, remove, rename or delete the tag (see the operation description). false for plain tags.

createdAt
string<date-time>
required