Skip to main content
POST
Add labels to a contact

Authorizations

Authorization
string
header
required

The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.

Headers

cloudchat-instance
integer
required

Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.

Example:

1

Path Parameters

accountId
integer
required

Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.

Example:

1

contactId
integer
required

The contact id — the contact.id returned by the conversation endpoints.

Example:

815

Body

application/json

The labels to apply, as titles. Every title has to be a label of the account already.

labels
string[]
required

Titles of the labels to add. Matched trimmed and case-insensitive; a repeated title counts once. One call accepts a limited number of titles and answers too_many_entries beyond it.

Example:

Response

The labels the contact carries now, which of the requested ones were newly applied, and the campaigns whose audience that may change.

The contact's labels after adding, and the campaigns that may be affected.

labels
string[]
required

Titles of every label the contact carries after the call.

Example:
added
string[]
required

The requested titles that were really applied now. Empty when the contact already carried all of them.

Example:
affected_campaigns
object[]
required

Active campaigns of the account whose audience uses a label this call really changed. Empty when none does, and when nothing changed. A non-empty list is a warning to pass on to whoever owns those campaigns.

Example: