Create Media

Headers

Authorization

string

required

Bearer token for authentication

Body

file

required

Image in png, jpg or svg format

data.type

string

required

Resource type identifier

Allowed value: "media"

data.attributes.media_type

enum<string>

Type of media (avatar, logo, banner)

Available options:

avatar,

logo,

banner

data.attributes.is_primary

boolean

default:true

Marks preferred media. Default: true

data.relationships.people.data[].type

string

Type for people relationship

Allowed value: "people"

data.relationships.people.data[].id

string<uuid>

UUID of the person to associate with this media

data.relationships.companies.data[].type

string

Type for company relationship

Allowed value: "company"

data.relationships.companies.data[].id

string<uuid>

UUID of the company to associate with this media

data.relationships.workspaces.data[].type

string

Type for workspace relationship

Allowed value: "workspace"

data.relationships.workspaces.data[].id

string<uuid>

UUID of the workspace to associate with this media

data.relationships.workspaces.data[].external_workspace_id

string<uuid>

UUID of the external workspace to associate with this media

Response

Media created successfully

data

object

Show child attributes

data.type

string

Allowed value: "media"

data.id

string<uuid>

data.attributes

object

Show child attributes

data.attributes.media_type

enum<string>

Available options:

avatar,

logo,

banner

data.attributes.url

string<uri>

URL to the media file

data.attributes.is_primary

boolean

Whether this is the primary media

data.attributes.processed_at

string<date-time>

Timestamp when media processing completed

data.attributes.uploaded_at

string<date-time>

data.relationships

object

Show child attributes

data.relationships.people

object

Show child attributes

data.relationships.people.data

object[]

Show child attributes

data.relationships.people.data.type

string

Allowed value: "people"

data.relationships.people.data.id

string<uuid>

data.relationships.companies

object

Show child attributes

data.relationships.companies.data

object[]

Show child attributes

data.relationships.companies.data.type

string

Allowed value: "company"

data.relationships.companies.data.id

string<uuid>

data.relationships.workspaces

object

Show child attributes

data.relationships.workspaces.data

object[]

Show child attributes

data.relationships.workspaces.data.type

string

Allowed value: "workspace"

data.relationships.workspaces.data.id

string<uuid>

data.included

object

Show child attributes

data.included.people

object

Show child attributes

data.included.people.data

object[]

Show child attributes

data.included.people.data.type

string

Allowed value: "people"

data.included.people.data.id

string<uuid>

data.included.people.data.attributes

object

Show child attributes

data.included.people.data.attributes.first_name

string

The person's first name

data.included.people.data.attributes.last_name

string

The person's last name

data.included.people.data.attributes.full_name

string

The person's full name (typically first_name + last_name)

data.included.people.data.attributes.created_at

string<date-time>

Timestamp when the person was created

data.included.people.data.attributes.updated_at

string<date-time>

Timestamp when the person was last updated

data.included.companies

object

Show child attributes

data.included.companies.data

object[]

Show child attributes

data.included.companies.data.type

string

Allowed value: "company"

data.included.companies.data.id

string<uuid>

data.included.companies.data.attributes

object

Show child attributes

data.included.companies.data.attributes.description

string

data.included.companies.data.attributes.domain_name_primary_link_url

string<url>

The domain url from the website or email address of the company. Used as unique identifier in some cases.

Maximum string length: 500

data.included.companies.data.attributes.tax_id

object

Show child attributes

data.included.companies.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.included.companies.data.attributes.tax_id.type

string

Type of tax ID, useful for applying formatting and validation rules.

data.included.companies.data.attributes.registration

object

Show child attributes

data.included.companies.data.attributes.registration.trade_name

string

Commercial or branding name (if different from registered name).

data.included.companies.data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.included.companies.data.attributes.registration_number

object

Show child attributes

data.included.companies.data.attributes.registration_number.business_type

string

Legal entity structure type.

data.included.companies.data.attributes.registration_number.value

string

Official company registration number.

data.included.companies.data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.included.companies.data.attributes.registration_number.registry_country

string

Country of the registry authority. (string (ISO 3166-1 alpha-2))

data.included.companies.data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.included.companies.data.attributes.created_at

string<date-time>

data.included.companies.data.attributes.updated_at

string<date-time>

data.included.workspaces

object

Show child attributes

data.included.workspaces.data

object[]

Show child attributes

data.included.workspaces.data.type

string

Allowed value: "workspace"

data.included.workspaces.data.id

string<uuid>

data.included.workspaces.data.attributes

object

Show child attributes

data.included.workspaces.data.attributes.name

string

Workspace name

data.included.workspaces.data.attributes.desription

string

Workspace description

data.included.workspaces.data.attributes.external_workspace_id

string<uuid>

external workspace id

data.included.workspaces.data.attributes.avatar_color

string<colors>

Color of the avatar

data.included.workspaces.data.attributes.created_at

string<date-time>

Timestamp when the workspace was created

data.included.workspaces.data.attributes.updated_at

string<date-time>

Timestamp when the workspace was last updated

data.included.invoice_item

object

Show child attributes

data.included.invoice_item.data

object[]

Show child attributes

data.included.invoice_item.data.type

string

Allowed value: "invoice_item"

data.included.invoice_item.data.id

string<uuid>

data.included.invoice_item.data.attributes

object

Show child attributes

data.included.invoice_item.data.attributes.line_id

string

Line identifier within the invoice

Example:

"1"

data.included.invoice_item.data.attributes.sku

string

Stock Keeping Unit identifier

Example:

"WM-1001"

data.included.invoice_item.data.attributes.name

string

Product or service name

Example:

"Wireless Mouse"

data.included.invoice_item.data.attributes.description

string

Detailed description of the item

Example:

"Ergonomic wireless mouse with USB receiver"

data.included.invoice_item.data.attributes.unit_price

number<decimal>

Unit price in local currency

Required range: x >= 0

Example:

25

data.included.invoice_item.data.attributes.currency

string

ISO 4217 currency code

Example:

"EUR"

data.included.invoice_item.data.attributes.unit

string

Unit of measurement

Example:

"EA"

data.included.invoice_item.data.attributes.min_quantity

integer

Minimum quantity allowed

Required range: x >= 0

Example:

1

data.included.invoice_item.data.attributes.max_quantity

integer

Maximum quantity allowed

Required range: x >= 1

Example:

500

data.included.invoice_item.data.attributes.tax

object

Show child attributes

data.included.invoice_item.data.attributes.tax.rate

number<decimal>

Tax rate as percentage

Required range: 0 <= x <= 100

Example:

20

data.included.invoice_item.data.attributes.tax.category

string

Tax category

Example:

"standard"

data.included.invoice_item.data.attributes.tax.scheme

string

Tax scheme identifier

Example:

"VAT"

data.included.invoice_item.data.attributes.period

object

Show child attributes

data.included.invoice_item.data.attributes.period.start

string<date>

Service period start date

Example:

"2025-06-26"

data.included.invoice_item.data.attributes.period.end

string<date>

Service period end date

Example:

"2025-06-27"

data.included.invoice_item.data.attributes.created_at

string<date-time>

Creation timestamp

Example:

"2025-05-11T13:42:12Z"

data.included.invoice_item.data.attributes.updated_at

string<date-time>

Last update timestamp

Example:

"2025-05-11T13:45:20Z"

Main Resources

Atomic Resources

System

Headers

Body

Response