Skip to main content
PATCH
cURL

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

id
string
required

Contact identifier

Body

application/merge-patch+json

The updated Contact resource

name
string | null
email
string | null
phone
string | null
organisation
string | null
role
string | null
twitter
string | null
linkedin
string | null
instagram
string | null
bio
string | null
country
string<iri-reference> | null
Example:

"/api/v1/countries/1"

town
string<iri-reference> | null
Example:

"/api/v1/towns/1"

isEmailConfirmed
boolean | null
localCenter
string<iri-reference> | null
Example:

"/api/v1/local_centers/1"

companyIdentifier
string | null
companyName
string | null
companyAddress
string | null
customFieldValues
string<iri-reference>[]
Example:
professionOrganisationRole
string | null
companyRegNo
string | null
notes
string | null
status
string<iri-reference> | null
Example:

"/api/v1/profile_statuses/1"

gender
string | null
dateBirth
string<date-time> | null

Response

Contact resource updated

id
integer
read-only
name
string | null
email
string | null
phone
string | null
organisation
string | null
role
string | null
twitter
string | null
linkedin
string | null
instagram
string | null
logo
string | null
bio
string | null
country
object | null
isNewsletterSubscribed
boolean | null
stripeCustomerId
string | null
town
object | null
dateCreated
string<date-time> | null
read-only
isValidatedIdentity
boolean
read-only
isValidatedIdentityPending
boolean
read-only
identity
object | null
isEmailConfirmed
boolean | null
localCenter
object | null
product
string<iri-reference> | null
Example:

"/api/v1/products/1"

companyIdentifier
string | null
companyName
string | null
companyAddress
string | null
customFieldValues
object[]
professionOrganisationRole
string | null
companyRegNo
string | null
notes
string | null
status
object | null
lastStatusUpdate
string<date-time> | null
tags
object[]
gender
string | null
dateBirth
string<date-time> | null
source
string | null
fullName
string | null
read-only
firstName
string | null
read-only
lastName
string | null
read-only
age
integer | null
read-only