Set or clear a person's external_id
The external_id is the only field of a person a key may write. It is unique in the account: one that another person carries is refused with DUPLICATE_EXTERNAL_ID.
Authorization
bearerAuth An API key minted by an admin under Settings → Developers. It is bound to one company and has a scope: read, or read_write. A request without one, or with one that is not ours, is answered 401 and metered by its client address (x-rate-limits).
In: header
Path Parameters
The record's id, or ext:<external_id> for the record that carries your own key. A person is also named by email:<address>.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/users/string" \ -H "Content-Type: application/json" \ -d '{ "external_id": "string" }'{ "object": "user", "id": "string", "external_id": "string", "name": "string", "email": "string", "role": "organisation_admin", "default_hourly_rate": 0, "updated_at": "string"}