Sign in

v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB
Files

Upload files

You can upload several files at a time by adding parameters to the root of the request body. The name of each parameter will be used as the label of the file once uploaded. E.g:

  • parameter name: package-damaged.png
  • parameter value: Content of the file.
post/api/upload

Query parameters

type'public_attachment' | 'attachment' | 'profile_picture' | 'widget_picture'
Example:attachment

The type of file to upload. If not specified, the file will be uploaded as a private attachment.

Response

A list of files

content_typestring

The content type of the file.

namestring

The name of the file.

sizeinteger

The size of the file (in bytes).

urlstring url

The URL of the file.

Example response

[
  {
    "content_type": "image/png",
    "name": "package-damaged.png",
    "url": "https://gorgias.io/attachments/package-damaged.png"
  }
]