Add tags

POST

/contact/{identifier}/tag

curl --request POST \
  --url https://api.aelyst.ai/v1/contact/example/tag \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[ "abc" ]'

• Production

Adds tags for a specific contact.

Authorizations

• BearerAuth

Parameters

Path Parameters

identifier

required

string

Identifier of the contact that can either be a phone number, email or contact ID. Examples: id:123 , email:abdc@gmail.com , phone:+60121233112

Request Body

Media typeapplication/json

Array of tags to be added to the contact

Array<string>

>= 1 items <= 10 items unique items

Examples

ExampleTags

[
  "abc"
]

Responses

200

Media typeapplication/json

object

contactId

ID of the contact on which the action was performed.

integer

Example^generated

{
  "contactId": 1
}

400

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 400,
  "message": "Validation error."
}

401

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 401,
  "message": "UN_AUTHORIZED"
}

429

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 429,
  "message": "Too Many Requests"
}

Headers

Retry-After

number

Example

1

Number of seconds until you can retry the request

X-RateLimit-Limit

number

Example

10

Number of request allowed for this end point

X-RateLimit-Remaining

number

Example

5

Number of request remaining for this end point

449

object

code

integer

message

string

Example

{
  "code": 449,
  "message": "Your request cannot be processed at the moment as it is currently in queue. Please try again in a few minutes."
}

object

code

integer

Example

449

message

string

Example

Your request cannot be processed at the moment as it is currently in queue. Please try again in a few minutes.

object

code

integer

Example

449

message

string

Example

Your request cannot be processed at the moment as it is currently in queue. Please try again in a few minutes.

500

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 500,
  "message": "Unexpected error occurred"
}