Create an attachment

POST 
/v1/attachments

Make a request to create an attachment

Request

multipart/form-data

Body

The request body to be sent with this request

oneOf

fileAttachment

file binaryrequired

The file to be uploaded

description string

A description of the attachment

urlAttachment

file_url urlrequired

A publicly accessible url to fetch the attachment from

description string

A description of the attachment

Responses

201

Created

application/json

Schema

Schema

attachment object

id integer

The unique identifier for the attachment

description string

The description of the attachment

Example (from schema)

{
  "attachment": {
    "id": 1,
    "description": "vehicle registration certificate"
  }
}

400

Bad Request

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "The file could not be read from the url"
}

422

Unprocessable Content

application/json

Schema

Schema

message string
errors object
file string[]
description string[]

Example (from schema)

{
  "message": "The given data was invalid",
  "errors": {
    "file": [
      "The file is required"
    ],
    "description": [
      "The description must be a string"
    ]
  }
}

Loading...