API Reference

Update a customer (only the fields sent; optimistic version); 200 unchanged when nothing differs

patch
https://apis.kentro.live/channel/v1/customers/

Scope: customers:write, channel:write or admin.

Idempotency: send Idempotency-Key; a retry with the same key replays the first answer.

Rate limit: write class, 1,200 requests per minute per tenant by default (read class 6,000). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a refusal is 429 rate_limited with Retry-After.

Path Params
string
required
length between 1 and 300

The uuid, a legacy 24-hex id, or ext:: (URL-encoded).

Body Params
string
length between 1 and 64

The version this change was based on; stale is 409 version_conflict.

length between 1 and 255

The integration's own id for the document, unique within its channel.

string
length ≤ 1000
length ≤ 255
length ≤ 255
length ≤ 255
length ≤ 255
boolean

true reactivates an inactive customer.

boolean
taxExemptions
array of strings
length ≤ 100

Tax exemption codes; replaces the whole list, [] clears it.

taxExemptions
boolean
length ≤ 24
^[0-9]{1,14}(\.[0-9]{1,8})?$

A non-negative decimal amount in currency units ("12.50"); numbers are accepted.

^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|[0-9a-fA-F]{24})$

A uuid, or a legacy 24-hex id.

userGroupIds
array of strings
length ≤ 100

User groups of the tenant; replaces the whole list, [] clears it.

userGroupIds
null

When the customer was retired (the legacy TTL tombstone); readers treat any value as gone, not as a future end date.

string
length ≤ 1000

Plain password, hashed with bcrypt (cost 10). 8 characters to 72 bytes after trimming.

string
length between 1 and 255

A pre-hashed password stored exactly as sent (no hashing, no format check): a bcrypt hash verifies at login, anything else fails every login until a password is set. Exclusive with password.

addresses
array of objects
length ≤ 50

Replaces the whole set; [] clears it.

addresses
metadata
object

Merged by key; a null value removes the key.

Headers
string
length between 7 and 50

Any string of 7 to 50 characters that identifies this request (an order number, a webhook id). A retry with the same key and the same body answers the first result with Idempotent-Replayed: true; the same key with a different body is 422 idempotency_key_reused; a concurrent request with the same key is 409 in_progress with Retry-After. Recommended on every write.

Responses

Updated about 1 hour ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago

Did this page help you?