Users

Update a user

Update a user record. If groups are provided, the user's groups will be replaced with the new set.

patch/v1/users/{id}

Request

  • Base URL
    https://api.capacity.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-capacity-id
    • or HTTP bearer

Path parameters

idstring required

Request body

emailstring
groupsstring[] required

Ids of groups of which the user will be a member

first_namestring
last_namestring
custom1string nullable

Field for storing custom user data

custom2string nullable

Field for storing custom user data

Response

The updated user

idstring
first_namestring
last_namestring
emailstring
is_deletedunknown
custom1string nullable
custom2string nullable

Changes

No recorded changes to this operation across all 1 revision of this API.