ScalixScalix Docs
Sign up

Support API

REST API endpoints for Support.

REST API endpoints for Support. 11 operations.

List support chat sessions

plaintext
GET /v1/support/chat/sessions

Requires an org credential (no dedicated scope).

Auth: Bearer API key

Responses

StatusDescription
200List support chat sessions
401Missing or invalid API key
500Internal error

operationId: listSupportChatSessions

Start a support chat session

plaintext
POST /v1/support/chat/sessions

Requires an org credential (no dedicated scope).

Auth: Bearer API key

Responses

StatusDescription
200Start a support chat session
401Missing or invalid API key
500Internal error

operationId: createSupportChatSession

List support chat messages

plaintext
GET /v1/support/chat/sessions/{id}/messages

Requires an org credential (no dedicated scope).

Auth: Bearer API key

Responses

StatusDescription
200List support chat messages
401Missing or invalid API key
500Internal error

operationId: listSupportChatMessages

Post a support chat message

plaintext
POST /v1/support/chat/sessions/{id}/messages

Requires an org credential (no dedicated scope).

Auth: Bearer API key

Responses

StatusDescription
200Post a support chat message
401Missing or invalid API key
500Internal error

operationId: postSupportChatMessage

List support tickets

plaintext
GET /v1/support/tickets

Requires an org credential (no dedicated scope).

Auth: Bearer API key

Responses

StatusDescription
200List support tickets
401Missing or invalid API key
500Internal error

operationId: listSupportTickets

Open a support ticket

plaintext
POST /v1/support/tickets

Requires an org credential (no dedicated scope).

Auth: Bearer API key

Responses

StatusDescription
200Open a support ticket
401Missing or invalid API key
500Internal error

operationId: createSupportTicket

Get a support ticket

plaintext
GET /v1/support/tickets/{id}

Requires an org credential (no dedicated scope).

Auth: Bearer API key

Responses

StatusDescription
200Get a support ticket
401Missing or invalid API key
500Internal error

operationId: getSupportTicket

Update a support ticket

plaintext
PUT /v1/support/tickets/{id}

Requires an org credential (no dedicated scope).

Auth: Bearer API key

Responses

StatusDescription
200Update a support ticket
401Missing or invalid API key
500Internal error

operationId: updateSupportTicket

Close a support ticket

plaintext
POST /v1/support/tickets/{id}/close

Requires an org credential (no dedicated scope).

Auth: Bearer API key

Responses

StatusDescription
200Close a support ticket
401Missing or invalid API key
500Internal error

operationId: closeSupportTicket

List ticket comments

plaintext
GET /v1/support/tickets/{id}/comments

Requires an org credential (no dedicated scope).

Auth: Bearer API key

Responses

StatusDescription
200List ticket comments
401Missing or invalid API key
500Internal error

operationId: listSupportTicketComments

Comment on a support ticket

plaintext
POST /v1/support/tickets/{id}/comments

Requires an org credential (no dedicated scope).

Auth: Bearer API key

Responses

StatusDescription
200Comment on a support ticket
401Missing or invalid API key
500Internal error

operationId: addSupportTicketComment