Skip to main content
POST
Append item to custom attribute

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Path Parameters

name
string
required

Name of the list type custom attribute

Query Parameters

identifier
string

Person ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request

sender
string

Sender or application ID. sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL

type
enum<string>

Type of the person ID

Available options:
ID,
EXTERNAL_ID,
PHONE,
EMAIL,
LINE,
FACEBOOK,
TELEGRAM,
PUSH,
WEB_PUSH,
LIVE_CHAT,
VIBER_BOTS,
INSTAGRAM,
INSTAGRAM_DM,
TWITTER,
APPLE_BUSINESS_CHAT,
KAKAO_SANGDAM,
OPEN_CHANNEL,
ZALO_FOLLOWER,
TIKTOK_BM,
WHATSAPP,
KAKAO_TALK

Response

successful response