Close a chat

Closes an active chat

Try this request in your browser

/api/ /chats/close

Headers

X-API-Token

Parameters

chat String 

The request output will be shown here...

URL

https://api.natterly.com/api/v1/chats/close

Access

Must be authenticated as a user. If not authorised, a MustBeAuthenticated error will be returned.

Parameters

Parameter Type Default

chat Required

The UUID of the chat

 String null

Errors

Error Attributes

ChatNotFound

No chat found with the given UUID

  • chat

    The provided chat UUID

ChatNotCloseable

The given chat cannot be closed

Response Data

This action will return a Boolean.