Create a comment

POST

/contact/{identifier}/comment

curl --request POST \
  --url https://api.aelyst.ai/v1/contact/example/comment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "text": "This is a comment" }'

• Production

Adds a comment to the specific contact for internal reference.

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^required

You can mention other users using {{@user.ID}} in the comment where ID is the user ID.

Media typeapplication/json

object

text

required

string

<= 1000 characters

Examples

{
  "text": "This is a comment"
}

{
  "text": "Please look into this contact {{@user.1}}"
}

{
  "text": "Comment about {{$contact.name}}"
}

Responses

200

Media typeapplication/json

object

contactId

ID of the contact for which the comment was added.

integer

text

Text of the comment.

string

created_at

Unix timestamps in seconds representing the time at which the comment was added.

integer

Example

{
  "text": "You just commented from the API",
  "created_at": 1662979868
}

400

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 400,
  "message": "Comment length must not be greater than 1000 characters"
}

401

Media typeapplication/json

object

code

integer

message

string

Example

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

404

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 404,
  "message": "Contact not found"
}

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

Media typeapplication/json

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."
}

500

Media typeapplication/json

object

code

integer

message

string

Example

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