Close conversation

This method is used for closing conversations.

URL

POST https://api.dashly.app/conversations/{id}/close

ID of the conversation should be used as {id}.

Parameters

Authentification parameters. id_as_string parameter.

Parameter	Type	Description
from_admin	ID/default_admin	ID of admin who closes the conversation or default_admin to close as default admin.
random_id	Optional[integer]	random integer to validate created message with RTS message. Default: 0

Note

If the conversation is already assigned to this admin, the answer with 200 status will be returned.

Use from_admin to control the admin who closes the conversation.

Response

In case new message was created, data field will contain the wollowing:

• id: ID - created assignment message identificator
• part_group: ID - identificator of conversation part, owning created message

Example:

{
  "data": {
    "id": 123,
    "part_group": 345
  },
  "meta": {
    "status": 200
  }
}

Exceptions

Standart Web API exceptions

Example

Close conversation with ID=716 as admin with ID=912:

curl -X POST \
  -H "Authorization: Token XXX" \
  --data-urlencode "from_admin=912" \
  "https://api.dashly.app/conversations/716/close"