Close a chat

Closes an active chat

Try this request in your browser

/api/ /chats_for_sessions/close

Headers

X-Session-ID

Parameters

chat String 

The request output will be shown here...

URL

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

Access

Must be authenticated as a session If not authorised, a MustBeAuthenticatedAsSession 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 given UUID

ChatNotCloseable

The given chat cannot be closed

Response Data

This action will return a Boolean.