Support

The Support Email Object


id `string` Unique identifier, prefixed with `sup_eml_`.
object `string` Always `support_email`.
organization `Object` The organization the request came from, as `{ id }`.
status `string` One of `queued`, `sent` or `failed`.
reply_to `string` Where support replies are directed. Always present, since every request must supply it.
created_by_details `object` Who filed the request: `id`, `name`, and `type`. The type is `user` when a person authenticated and `api_key` when an integration did, so you can tell a human-raised ticket from an automated one.
subject `string` The subject line.
attachment_count `number` How many files were attached.
is_sandbox `boolean` Whether the request was validated without being delivered.
provider `Object` Delivery details, as `{ message_id, status_code }`.
errors `Object[]` Why a `failed` request was rejected. Empty otherwise.
created_at `number` When the request was recorded, in epoch seconds.
updated_at `number` When the record last changed, in epoch seconds.
completed_at `number` When the send attempt finished, or `null`. `status` says how it went.

The message body is returned when you retrieve a single request, but not when listing them. Retrieving one also returns its attachments.

The Attachment Object

Returned in the attachments array when you retrieve a single support request. These four fields are the whole object - nothing about where the file is stored is returned.


id `string` Unique identifier for the attachment on a submitted request, prefixed with `sup_att_`.
filename `string` The name the support agent sees.
content_type `string` The file's content type, or `null`. Read from storage after the upload, not taken from what you declared.
size_bytes `number` File size in bytes, or `null`. Also read from storage.

The Upload Slot

A different shape, returned once by POST /v1/support/attachments when you ask for somewhere to upload a file. It is never part of a support request record.


object_path `string` Pass this back in `attachments` when you submit the request.
upload_url `string` Upload the file here with a `PUT`. Valid for one hour.
filename `string` The filename you asked for.
required_headers `Object` Headers you must send on the `PUT`, exactly as given. See the Send page.