Initiate a chat

Initiates a new chat with an existing session

Try this request in your browser

/api/ /chats/initiate

Headers

X-API-Token

Parameters

session String
subject String
department String 

The request output will be shown here...

URL

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

Access

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

Parameters

Parameter Type Default

session Required

The UUID of the session to initiate a chat with

 String null

subject Required

The first message to be sent to the chat

 String null

department

The UUID of the department the initiated chat should belong to

 String null

Errors

Error Attributes

DepartmentNotFound

No department found with the given UUID

  • department

    The provided department UUID

InvalidChatObject

The chat object failed validations

  • errors

    The validation errors

SessionNotFound

No session found with the given UUID

  • session

    The provided session UUID

Response Data

This action will return a Hash.