Open/close conversation

POST

/contact/{identifier}/conversation/status

curl --request POST \
  --url https://api.aelyst.ai/v1/contact/example/conversation/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "open" }'

• Production

Update the conversation status to open or close. You can provide the conversation category and summary in the API call along when update the conversation status to close.

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

object

status

required

Status of the conversation which can either be open or close

string

Allowed values: open close

category

Optionally provide the closing note name.

string

<= 128 characters

summary

Optionally provide a summary. Only used if the category is specified.

string

<= 512 characters

Examples

{
  "status": "open"
}

{
  "status": "close",
  "category": "Spam",
  "summary": "This contact is a bot"
}

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

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