Update a contact

Authorization

AuthorizationBearer <token>

Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.

In: header

Path Parameters

id*string

UUIDv7 identifier of the resource.

Formatuuid

Header Parameters

Idempotency-Key?string

A unique key that makes this mutation safe to retry. Repeats replay the stored response; reuse with a different body returns 409 idempotency_conflict.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

All fields optional; only supplied fields are changed.

kind?string

Value in

"prospect"
"lead"
"customer"

first_name?string|null

last_name?string|null

company_name?string|null

company_number?|

Registered company number of a business licensee (Companies House or equivalent). Null for individuals, and for businesses whose number was not captured.

email?|

Formatemail

phone?string|null

address_line1?string|null

address_line2?string|null

city?string|null

region?string|null

postcode?string|null

country_code?string

Length2 <= length <= 2

date_of_birth?|

Formatdate

is_charity?boolean

is_connected_party?boolean

is_business?boolean

marketing_consent?boolean

relief_assist_requested?boolean

Ask the operator to apply for non-domestic rates relief on this customer's behalf. The customer's own authority and other-property declaration are captured separately; setting this alone never causes an application to be made.

notes?string|null

Response Body

`application/json`

curl -X PATCH "https://example.com/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "object": "contact",    "kind": "prospect",    "first_name": "string",    "last_name": "string",    "company_name": "string",    "company_number": "string",    "email": "user@example.com",    "phone": "string",    "address_line1": "string",    "address_line2": "string",    "city": "string",    "region": "string",    "postcode": "string",    "country_code": "st",    "date_of_birth": "2019-08-24",    "is_charity": true,    "is_connected_party": true,    "is_business": true,    "kyc_status": "not_required",    "marketing_consent": true,    "marketing_consent_at": "2019-08-24T14:15:22Z",    "relief_assist_requested": true,    "relief_assist_requested_at": "2019-08-24T14:15:22Z",    "notes": "string",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "archived_at": "2019-08-24T14:15:22Z"  }}

{  "error": {    "code": "unauthorized",    "message": "Missing or invalid credential."  }}

{  "error": {    "code": "insufficient_scope",    "message": "The credential lacks a scope required by this endpoint."  }}

{  "error": {    "code": "not_found",    "message": "Resource not found."  }}

{  "error": {    "code": "conflict",    "message": "The request conflicts with current resource state."  }}

{  "error": {    "code": "validation_error",    "message": "One or more fields are invalid.",    "details": [      {        "field": "email",        "issue": "must be a valid email address"      }    ]  }}

{  "error": {    "code": "rate_limited",    "message": "Rate limit exceeded. Retry after 7s."  }}

{  "error": {    "code": "validation_error",    "message": "string",    "details": [      {        "field": "string",        "issue": "string"      }    ]  }}

Update a contact

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`