Skip to main content
POST
Append items

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

listName
string
required

Name of the list attribute.

Minimum string length: 1

Query Parameters

type
enum<string>
required

Type of the person ID. Can be one of the above.

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

Person ID. ID type must match the type parameter.

Minimum string length: 1
sender
string

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

Body

application/json

Response

Success