Update a user

patch

https://api.emaktalk.com/api/v1/users/{id}

Updates either a person's account record (target: "user") or their own profile (target: "profile"); the two branches accept different fields, and a target that is neither answers 200 without changing anything. target: "profile" always updates the identity your API key authenticates as, whatever ID is in the path — with an API key that identity is the key itself, not the person who created it. A profile update replaces the stored language and timezone and clears any name or mobile field you leave out. The steps are not transactional, so a partial update is possible, and a 200 does not confirm that a person's record actually changed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

ID of the person to update; it must be a valid UUID, and a key with the User role must use its own ID.

Body Params

target

string

enum

required

user to update the person's account record, profile to update your own profile; a missing or unrecognized value answers 200 without changing anything.

Allowed:

domainId

string

Account the assignments and settings are written within; required for target: "profile" and sent as an empty value if you omit it.

language

string

enum

required

Interface language, en-us or fr-ca; required by both branches.

Allowed:

timezone

string

required

The person's timezone; required by both branches.

username

string

Sign-in name; required for target: "user", and an optional profile change that is checked for uniqueness.

defaultDomainId

string

The person's default account; used only by target: "user".

firstName

string

Given name; used by target: "user".

lastName

string

Family name; used by target: "user".

displayName

string | null

Name shown in the interface for target: "user"; omitting it writes null.

avatarId

string | null

Avatar for target: "user"; omitting it writes null.

domains

string

Account assignments for target: "user"; this assignment update does not run for an account-scoped API key.

groups

string

Group assignments for target: "user"; at least one is required, and you cannot grant a group that outranks your own API key.

extensions

string

Extension assignments for target: "user".

first_name

string | null

Given name for target: "profile"; omitting it clears the stored value.

last_name

string | null

Family name for target: "profile"; omitting it clears the stored value.

display_name

string | null

Display name for target: "profile"; omitting it clears the stored value.

mobile

string | null

Mobile number, used by both branches; omitting it clears the stored value.

password

string

New password for target: "profile"; it is hashed before storage and ignored when empty.

Responses

401

Missing or invalid API key.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The update ran, or target was unrecognized and nothing was changed.

400The ID or the request is invalid, or the update failed — including when you are not allowed to make the change you asked for.

403A key with the User role tried to update an identity other than its own.

404The request body is empty or could not be read.