Skip to main content
PUT
Create Core Edition

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Headers

If-Match
string | null
If-None-Match
string | null
X-Acting-User
string | null

The person acting through the access credential, recorded as created_by of what the request writes. Audit only: access is checked on the credential.

Required string length: 1 - 255

Path Parameters

organization_id
string
required

Body

application/json
dba_name
string | null
required

The trading name; null when none

Minimum string length: 1
Example:

"Acme"

incorporation_date
string<date> | null
required

Null when not incorporated

The registered name, as filed to HMRC

Required string length: 1 - 35
Example:

"Acme Trading Ltd"

logo_id
string | null
required

The logo printed on payslips, an uploaded organization logo document; null when none

shutdown_date
string<date> | null
required

The day the employer ceased trading; null while it trades

valid_from
string<date>
required
valid_to
string<date>
required
website
string | null
required
Example:

"https://acme.example/"

Response

Successful Response

created_at
string<date-time>
required
read-only
created_by
string
required
read-only

Who wrote the edition: the acting user (X-Acting-User, else the access credential), system for our own writes, or <authority>:<notice> for a write on an authority's behalf, e.g. hmrc:P6.

edition
integer
required
read-only
valid_from
string<date>
required
valid_to
string<date>
required
dba_name
string | null
incorporation_date
string<date> | null
logo_id
string | null
shutdown_date
string<date> | null
website
string | null