Post
Support case post management.
Create
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required | Default | Role |
|---|---|---|---|---|
| accountId | string | support | ||
| attachments | array | |||
| author | string | |||
| message | string | |||
| ticketId | string | yes |
Response
| Field | Type |
|---|---|
| accountId | string |
| attachments | array |
| author | string |
| message | string |
| id | string |
| ticketId | string |
Download
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required | Role |
|---|---|---|---|
| accountId | string | support | |
| id | string | yes | |
| key | string | yes |
Response
A download URL.
Find
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Role |
|---|---|---|
| accountId | string | support |
| id | string | |
| ticketId | string |
Query String Options
| Field | Type |
|---|---|
| hidden | boolean |
| filter | string |
| limit | number |
| next | object |
| prev | object |
| index | string |
| where | string |
| log | boolean |
Response
Paged response.
| Field | Type | Notes |
|---|---|---|
| data | array | An array of metrics each containing an array of metric with the following properties. |
| next | string | Paged cursor to use for the next page of items. |
| prev | string | Pages cursor to use for the previous page of items. |
Post
An array of Post items.
| Field | Type |
|---|---|
| accountId | string |
| attachments | array |
| author | string |
| message | string |
| id | string |
| ticketId | string |
Get
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required |
|---|---|---|
| id | string | yes |
| ticketId | string |
Query String Options
| Field | Type |
|---|---|
| hidden | boolean |
| filter | string |
| limit | number |
| next | object |
| prev | object |
| index | string |
| where | string |
| log | boolean |
Response
| Field | Type |
|---|---|
| accountId | string |
| attachments | array |
| author | string |
| message | string |
| id | string |
| ticketId | string |
Init
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
A object.
Response
| Field | Type |
|---|---|
| accountId | string |
| attachments | array |
| author | string |
| message | string |
| id | string |
| ticketId | string |
Remove
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required |
|---|---|---|
| id | string | yes |
| accountId | string | yes |
| ticketId | string | yes |
Query String Options
| Field | Type |
|---|---|
| hidden | boolean |
| filter | string |
| limit | number |
| next | object |
| prev | object |
| index | string |
| where | string |
| log | boolean |