Uploads one file, to be referenced by a later message on one of your tickets.

POST

/v1/integration/attachments

curl --request POST \
  --url https://api.example.com/v1/integration/attachments \
  --header 'Content-Type: multipart/form-data' \
  --form file=@file

• Placeholder: replace with the API address of your own installation.

The returned id is usable only by the token that uploaded it, only once, and only within 24 hours. Send it in attachmentIds on POST /v1/integration/tickets/{id}/messages. Size and type limits are the deployment’s own — see GET /v1/attachments/configuration.

Request Body^required

Media typemultipart/form-data

object

file

string format: binary

Responses

201

Created

object

data

One of:

object

object

id

required

/^-?(?:0|[1-9]\d*)$/

objectKey

required

string

originalFileName

required

string

contentType

required

string

fileSize

required

/^-?(?:0|[1-9]\d*)$/

createdAt

required

string format: date-time

success

boolean

error

One of:

object

object

status

/^-?(?:0|[1-9]\d*)$/

code

string

nullable

details

message

string

object

data

One of:

object

object

id

required

/^-?(?:0|[1-9]\d*)$/

objectKey

required

string

originalFileName

required

string

contentType

required

string

fileSize

required

/^-?(?:0|[1-9]\d*)$/

createdAt

required

string format: date-time

success

boolean

error

One of:

object

object

status

/^-?(?:0|[1-9]\d*)$/

code

string

nullable

details

message

string

Example^generated

{
  "data": {
    "id": "example",
    "objectKey": "example",
    "originalFileName": "example",
    "contentType": "example",
    "fileSize": "example",
    "createdAt": "2026-04-15T12:00:00Z"
  },
  "success": true,
  "error": {
    "status": "example",
    "code": "example",
    "details": "example",
    "message": "example"
  }
}

object

data

One of:

object

object

id

required

/^-?(?:0|[1-9]\d*)$/

objectKey

required

string

originalFileName

required

string

contentType

required

string

fileSize

required

/^-?(?:0|[1-9]\d*)$/

createdAt

required

string format: date-time

success

boolean

error

One of:

object

object

status

/^-?(?:0|[1-9]\d*)$/

code

string

nullable

details

message

string

Example^generated

{
  "data": {
    "id": "example",
    "objectKey": "example",
    "originalFileName": "example",
    "contentType": "example",
    "fileSize": "example",
    "createdAt": "2026-04-15T12:00:00Z"
  },
  "success": true,
  "error": {
    "status": "example",
    "code": "example",
    "details": "example",
    "message": "example"
  }
}

401

Unauthorized

object

type

string

nullable

title

string

nullable

status

nullable /^-?(?:0|[1-9]\d*)$/

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

nullable /^-?(?:0|[1-9]\d*)$/

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": "example",
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

nullable /^-?(?:0|[1-9]\d*)$/

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": "example",
  "detail": "example",
  "instance": "example"
}

403

Forbidden

object

type

string

nullable

title

string

nullable

status

nullable /^-?(?:0|[1-9]\d*)$/

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

nullable /^-?(?:0|[1-9]\d*)$/

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": "example",
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

nullable /^-?(?:0|[1-9]\d*)$/

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": "example",
  "detail": "example",
  "instance": "example"
}

429

Too Many Requests

object

type

string

nullable

title

string

nullable

status

nullable /^-?(?:0|[1-9]\d*)$/

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

nullable /^-?(?:0|[1-9]\d*)$/

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": "example",
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

nullable /^-?(?:0|[1-9]\d*)$/

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": "example",
  "detail": "example",
  "instance": "example"
}