Skip to main content
PATCH
/
api
/
customers
/
update
Update Customer
curl --request PATCH \
  --url https://app.sphinxhq.com/api/customers/update/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "full_name": "<string>",
  "input_details": {},
  "sync_platforms": {},
  "delete_after": 123
}
'
{
  "external_id": "cust-123",
  "full_name": "Jane Smith"
}

Authorizations

​
Authorization
string
header
required

OAuth2 access token obtained from POST /api/oauth/token/ using client credentials.

Body

Serializer for partial customer updates. Only provided fields are applied.

​
external_id
string

External ID to identify the customer to update.

Maximum string length: 255
​
full_name
string

Full name of the customer.

Maximum string length: 255
​
customer_type
enum<string> | null

INDIVIDUAL or COMPANY.

  • INDIVIDUAL - Individual
  • COMPANY - Company
Available options:
INDIVIDUAL,
COMPANY,
,
null
​
input_details
object

Flexible JSON for customer fields.

​
sync_platforms
object

External platform references for outbound sync. List of dicts, e.g. [{"domain": "bofi--dev.sandbox.my.salesforce.com", "id": "500WA..."}]

​
delete_after
integer

Number of days until deletion. Use 0 for immediate, -1 for never.

Response

200 - application/json

Read-only serializer for Customer with computed fields.

​
id
integer
required
read-only
​
external_id
string | null
required
read-only

ID from the source system, for lookups.

​
full_name
string
required
read-only
​
customer_type
enum<string> | null
required
read-only
  • INDIVIDUAL - Individual
  • COMPANY - Company
Available options:
INDIVIDUAL,
COMPANY,
null
​
input_details
object
required
read-only

Flexible JSON for inputting customer fields such as first_name, address, etc. Any format accepted.

​
sync_platforms
object
required
read-only

External platform references. List of dicts, e.g. [{"domain": "bofi--dev.sandbox.my.salesforce.com", "id": "500WA..."}]

​
delete_after
integer
required
read-only

Days until deletion. -1 means never delete.

​
created_at
string<date-time>
required
read-only
​
updated_at
string<date-time>
required
read-only