post
https://api.anduin.app/api/v1/idm//clients/upsert
Create a Client if none exists with the given Tracking ID, or update the existing one otherwise.
This is an idempotent operation: calling it twice with the same payload results in the same end state. Safe to retry on network failure, or to replay as part of a scheduled sync from your CRM or source system.
Matching rule
The Client is matched by the trackingId you supply in the request body. trackingId is required — requests without a trackingId are rejected with a 400 Bad Request. Use the regular Create Client endpoint if you want to create a Client without a Tracking ID.
Response
The response always includes the full Client object plus a result field:
"result": "created"— no match was found, a new Client was created."result": "updated"— an existing Client was found and its fields were updated.
Field semantics
| Field | Create | Update |
|---|---|---|
trackingId | Required (match key). | Required (match key). |
name | Required. | Replace if present; omit = unchanged. |
tags | Optional; defaults to []. | Replace if present (empty array clears); omit = unchanged. |
clientGroupId | Optional; defaults to the Unassigned group. | Reassign if present; omit = unchanged. |
note | Optional. | Replace if present; omit = unchanged. |
Validation errors return 400 Bad Request with the offending field name.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…