Support
10 routes. Paths are relative to https://api.intersink.com/v1.
- GET/support/channels/{channelId}/ticketsList the channel's tickets (?status=&priority=&assigned_to=me|none|<id>)
- GET/support/channels/{channelId}/tickets/{id}Get a ticket with the full thread (incl. notes)
- PATCH/support/channels/{channelId}/tickets/{id}Change status / priority / assignee
- POST/support/channels/{channelId}/tickets/{id}/messagesReply (or add an internal note) as staff
- GET/support/ticketsList my tickets (?channel_id=&status=&page=&limit≤50)
- POST/support/ticketsOpen a ticket with a channel
- GET/support/tickets/{id}Get one of my tickets with its thread
- POST/support/tickets/{id}/closeClose my ticket
- POST/support/tickets/{id}/messagesReply on my ticket (reopens pending/resolved)
- POST/support/tickets/{id}/reopenReopen my resolved/closed ticket
List the channel's tickets (?status=&priority=&assigned_to=me|none|<id>)
GET/support/channels/{channelId}/tickets
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| page | number, query | Minimum 1, maximum 10000. |
| limit | number, query | Minimum 1, maximum 50. |
| status | string, query | One of: "open", "pending", "resolved", "closed". |
| channel_id | string, query | Customer: only this channel |
| priority | string, query | One of: "low", "normal", "high", "urgent". |
| assigned_to | string, query | Assignee user id, or 'me' / 'none' At most 36 characters. |
Response
200. The payload in data is not described in the spec yet.
Get a ticket with the full thread (incl. notes)
GET/support/channels/{channelId}/tickets/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | number, path |
Response
200. The payload in data is not described in the spec yet.
Change status / priority / assignee
PATCH/support/channels/{channelId}/tickets/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | number, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| status | string | One of: "open", "pending", "resolved", "closed". |
| assigned_to | string | User id of a channel admin/manager, or null to unassign |
| priority | string | One of: "low", "normal", "high", "urgent". |
Response
200. The payload in data is not described in the spec yet.
Reply (or add an internal note) as staff
POST/support/channels/{channelId}/tickets/{id}/messages
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | number, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| attachment_ids | number[] | Drive file ids you uploaded (max 10) |
| messagerequired | string | At most 10000 characters. |
| internal | boolean | Internal note: never shown to the customer |
| status | string | Status to set with this reply (default: pending) One of: "open", "pending", "resolved", "closed". |
Response
201. The payload in data is not described in the spec yet.
List my tickets (?channel_id=&status=&page=&limit≤50)
GET/support/tickets
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| page | number, query | Minimum 1, maximum 10000. |
| limit | number, query | Minimum 1, maximum 50. |
| status | string, query | One of: "open", "pending", "resolved", "closed". |
| channel_id | string, query | Customer: only this channel |
Response
200. The payload in data is not described in the spec yet.
Open a ticket with a channel
POST/support/tickets
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| attachment_ids | number[] | Drive file ids you uploaded (max 10) |
| channel_idrequired | string | Channel the ticket is for |
| subjectrequired | string | At most 200 characters. Example: "Refund for a failed payment" |
| categoryrequired | string | At most 60 characters. Example: "Billing and purchases" |
| priority | string | One of: "low", "normal", "high", "urgent". |
| messagerequired | string | First message At most 10000 characters. |
Response
201. The payload in data is not described in the spec yet.
Get one of my tickets with its thread
GET/support/tickets/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Response
200. The payload in data is not described in the spec yet.
Close my ticket
POST/support/tickets/{id}/close
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Response
200. The payload in data is not described in the spec yet.
Reply on my ticket (reopens pending/resolved)
POST/support/tickets/{id}/messages
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| attachment_ids | number[] | Drive file ids you uploaded (max 10) |
| messagerequired | string | At most 10000 characters. |
Response
201. The payload in data is not described in the spec yet.
Reopen my resolved/closed ticket
POST/support/tickets/{id}/reopen
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Response
200. The payload in data is not described in the spec yet.