Initiate a chat

Start a new chat

Try this request in your browser

/api/ /chats_for_sessions/initiate

Headers

X-Session-ID

Parameters

subject String
department String 

The request output will be shown here...

URL

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

Access

Must be authenticated as a session If not authorised, a MustBeAuthenticatedAsSession error will be returned.

Parameters

Parameter Type Default

subject Required

The subject for the new chat

 String null

department

The UUID for a department

 String null

Errors

Error Attributes

ValidationError

A validation error occurred while creating the chat

  • errors

    The errors on the chat

DepartmentNotFound

No department was found with the given department UUID

Response Data

This action will return a chat structure.

You'll only receive basic attributes for this structure. You'll receive expansions for visitor, site, department.