Post
Support case post management.
Create
Create a support ticket post.
Endpoint
HTTP
POST /post/createAuthorized User Role
userRequest Body
| Field | Type | Required | Default | Notes |
|---|---|---|---|---|
| attachments | array | Attachments. | ||
| author | string | Author. | ||
| created | date | Created. | ||
| message | string | Message. | ||
| ticketId | string | yes | Ticket ID. |
Response
Post Record.
| Field | Type | Notes |
|---|---|---|
| accountId | string | Owning account ID. |
| attachments | array | Attachments. |
| author | string | Post author. |
| created | date | Post creation date. |
| message | string | Post message. |
| id | string | Post ID. |
| ticketId | string | Owning ticket ID. |
Download
Download a support ticket post attachment.
Endpoint
HTTP
POST /post/downloadAuthorized User Role
userRequest Body
| Field | Type | Required | Notes |
|---|---|---|---|
| id | string | yes | Post ID. |
| key | string | yes | Attachment key. |
Response
A download URL.
Find
Get a list of support ticket posts.
Endpoint
HTTP
POST /post/findAuthorized User Role
userRequest Body
| Field | Type | Notes |
|---|---|---|
| id | string | Post ID. |
| ticketId | string | Ticket ID. |
Query String Options
| Field | Type | Default | Notes |
|---|---|---|---|
| index | string | Index name: primary or gs1. | |
| limit | number | Limit number of results. | |
| next | object | Token for next page. | |
| prev | object | Token for previous page. |
Response
Paged response.
| Field | Type | Notes |
|---|---|---|
| data | array | An array of Post records. |
| 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
| Field | Type | Notes |
|---|---|---|
| accountId | string | Owning account ID. |
| attachments | array | Attachments. |
| author | string | Post author. |
| created | date | Post creation date. |
| message | string | Post message. |
| id | string | Post ID. |
| ticketId | string | Owning ticket ID. |
Get
Get a support ticket post by ID.
Endpoint
HTTP
POST /post/getAuthorized User Role
userRequest Body
| Field | Type | Required | Notes |
|---|---|---|---|
| id | string | yes | Post ID. |
| ticketId | string | Ticket ID. |
Query String Options
| Field | Type | Default | Notes |
|---|---|---|---|
| index | string | Index name: primary or gs1. | |
| limit | number | Limit number of results. | |
| next | object | Token for next page. | |
| prev | object | Token for previous page. |
Response
Post Record.
| Field | Type | Notes |
|---|---|---|
| accountId | string | Owning account ID. |
| attachments | array | Attachments. |
| author | string | Post author. |
| created | date | Post creation date. |
| message | string | Post message. |
| id | string | Post ID. |
| ticketId | string | Owning ticket ID. |