Assign/unassign conversation

POST

/contact/{identifier}/conversation/assignee

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

• Production

Updates the assignee of a specific contact. You can unassign the contact by leaving the assignee value empty.

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

object

assignee

required

User ID or email of the assignee user. Provide null to unassign the contact.

string

nullable

Examples

{
  "assignee": null
}

{
  "assignee": 1
}

{
  "assignee": "abc@gmail.com"
}

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