Organization API

Update one Customer

Updates organization-specific Customer profile fields and customFields. It does not mutate shared platform firstName, lastName, or email identity fields, and ownerId is rejected because Organization API v1 does not expose the staff reassignment action.

/api/v1/customers/{id}

Update one Customer. Use an organization API key with customers:write. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

customers:write

Parameters

Name	In	Type	Description
idrequired	path	string	Customer identifier returned by the Organization API.

Request body

objectrequired

Field	Type	Description
billingEmail	string \| null	Invoice recipient for this organization. Blank or null uses the contact email.
displayName	string \| null	Optional unless marked required.
emailOverride	string \| null	Optional unless marked required.
phoneOverride	string \| null	Optional unless marked required.
description	string \| null	Optional unless marked required.
internalNotes	string \| null	Optional unless marked required.
tags	array \| null	Optional unless marked required.
referralSource	string \| null	Optional unless marked required.
customFields	object	Field Values keyed by savedIdentity from GET /api/v1/schema.

updatecustomerRequest

{
  "internalNotes": "Prefers afternoon calls.",
  "customFields": {
    "preferredLanguage": "en"
  }
}

Responses

200

Updated Customer envelope

#/components/schemas/OrgApiResourceEnvelope

400

Validation error