Skip to main content
PUT
Create Contact 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
contacts
GBOrganizationContactEntry · object[]
required

Contacts; empty when none

hmrc_sender_email
string<email> | null
required

Where HMRC writes to the sender about the employer's filings; null when none

Example:

"payroll@acme.example"

valid_from
string<date>
required
valid_to
string<date>
required

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
contacts
GBOrganizationContactEntryRead · object[]
hmrc_sender_email
string | null