Tickets
Forward
Forwards the ticket by email to the given addresses with the supplied subject, body and attachments, recording the forward on the ticket and queueing the outbound email (calls are rejected once the forward rate limit is reached).
POST
/api/{tenant:minlength(2)}/v{version:apiVersion}/tickets/{id}/forward
- Authorisation
- Minimum role: USER
Request arguments
Request body example
Response
- Status
- 200 (OK)
- Type
- DTO_acknowledgement
- Wrapper
- DTO_response_wrap
- Other statuses
- 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_ticket_forward
| Name | Type | ReadOnly | Description |
|---|
| sys_attachments | DTO_reference_attachment[] | | Files to send with the forward, each referenced by its attachment id, prefilled by the forward preview with the attachments already on the ticket and its replies |
| created_by | DTO_reference_user | | The User who sent the forward, always taken from the calling User so a value supplied in the request is ignored |
| id | Int32 | ReadOnly | Id of the forward record created on the ticket, which the forward preview leaves at 0 because nothing has been created yet |
| subject | String | | Prefilled forward subject ("FW:" followed by the ticket subject) returned by the forward preview, ignored when forwarding because the sent email always derives its subject from the ticket |
| sys_content_rich | DTO_rich_text | | Body of the forward |
| email_addresses | DTO_email_address[] | | Who the forward goes to, each entry directed TO, CC or BCC (any other direction is rejected), capped at 20 recipients and at 3 on the free plan |
| created | DateTime | ReadOnly | When the forward was recorded on the ticket, in UTC |
DTO_acknowledgement
| Name | Type | ReadOnly | Description |
|---|
| message | String | | Message |
DTO_reference_attachment
| Name | Type | ReadOnly | Description |
|---|
| size_kb | Int32 | ReadOnly | Size kb |
| status | ENUM attachment_status | ReadOnly | Status |
| status_message | String | ReadOnly | Status message |
| download_url | String | ReadOnly | Download url |
| id | Int32 | | Id |
| label | Object | ReadOnly | Label |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|
| profile_pic | String | ReadOnly | Profile pic |
| email | String | ReadOnly | Email |
| id | Int32 | | Id |
| label | Object | ReadOnly | Label |
DTO_rich_text
| Name | Type | ReadOnly | Description |
|---|
| plain_preview | String | ReadOnly | Plain preview |
| html | String | | Html |
| editorjs | DTO_editorjs | | Editorjs |
| tiptap | DTO_tiptap | | Tiptap |
| read_minutes | Int32 | | Read minutes |
DTO_editorjs
| Name | Type | ReadOnly | Description |
|---|
| time | Int64 | | Time |
| version | String | | Version |
| blocks | DTO_editorjs_block[] | | Blocks |
DTO_editorjs_block
| Name | Type | ReadOnly | Description |
|---|
| id | String | | Id |
| type | String | | Type |
| data | Object | | Data |
DTO_tiptap_attrs
| Name | Type | ReadOnly | Description |
|---|
| textAlign | String | | Textalign |
| level | Int32 (nullable) | | Level |
| checked | Boolean (nullable) | | Checked |
| id | Int32 (nullable) | | Id |
| alt | String | | Alt |
| title | String | | Title |
| width | String | | Width |
| wrapperStyle | String | | Wrapperstyle |
| files | DTO_tiptap_file_ref[] | | Files |
| href | String | | Href |
| target | String | | Target |
| colspan | Int32 (nullable) | | Colspan |
| rowspan | Int32 (nullable) | | Rowspan |
| color | String | | Color |
| text | String | | Text |
| name | String | | For emoji |
| native | String | | For emoji |
DTO_tiptap_file_ref
| Name | Type | ReadOnly | Description |
|---|
| id | Int32 | | Id |
| label | String | | Label |
ENUM attachment_status
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | UNAVAILABLE | UNAVAILABLE, processing in progress |
| 2 | OK | OK |
| 3 | WARNING | WARNING |
| 4 | ERROR | ERROR |
ENUM email_address_direction
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | FROM | FROM |
| 2 | TO | TO |
| 3 | CC | CC |
| 4 | BCC | BCC |
| 5 | FORWARDED_TO | FORWARDED_TO |
| 6 | RESENT_FROM | RESENT_FROM |
| 7 | REPLY_TO | REPLY_TO |
Generated Aug 4, 2026 18:37
