Skip to main content
POST
/
media
Error
A valid request URL is required to generate request examples
{
  "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
  "mediaFolder": {
    "name": "invoice"
  },
  "isPrivate": true,
  "mimeType": "image/jpeg",
  "fileExtension": "jpg",
  "fileName": "invoice.jpg",
  "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
  "createdAt": "2021-01-01T00:00:00+00:00"
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Query Parameters

​
folder
enum<string>
required

Media folder id

Available options:
invoice,
subscription,
debitor,
payment,
payment-sepa-mandate,
payment-sepa-xml,
contract,
product,
upload,
default
Example:

"invoice"

Body

multipart/form-data
​
file
file
required

Response

Media resource created

​
id
object
Example:

"01F9Z3ZJXZQZJZJZJZJZJZJZJZ"

​
mediaFolder
object
​
isPrivate
boolean

Whether the media is public accessible or not

Example:

true

​
mimeType
string | null

The mime type of the media

Example:

"image/jpeg"

​
fileExtension
string

The file extension of the media

Example:

"jpg"

​
fileName
string

The original file name of the media

Example:

"invoice.jpg"

​
storageFileName
string

The file name of the media in the storage

Example:

"01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg"

​
createdAt
string<date-time>

The date and time when the media was created

Example:

"2021-01-01T00:00:00+00:00"