Skip to main content
Add a delivery address to a company

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
required

What people call the place, e.g. the building; printed as the delivery party.

Required string length: 1 - 500
street
string | null
required
Maximum string length: 500
postal_code
string | null
required
Maximum string length: 50
city
string | null
required
Maximum string length: 200
country_code
string
required

ISO 3166-1 alpha-2.

Pattern: ^[A-Z]{2}$

Response

The new address.

id
string<uuid>
required
name
string
required
street
string | null
required
postal_code
string | null
required
city
string | null
required
country_code
string | null
required

ISO 3166-1 alpha-2.

source_system
string | null
required

The accounting system it is synced from, which owns it: it changes there, not here. Null for an address made in Watchdog.

is_default
boolean
required

Marked as the company default by an Admin.