Users

Update a user

Updates an existing user's information. All fields are optional - only provide the fields you want to update.

You can update basic information like name, as well as organizational assignments like team membership, cost center codes, and employee IDs.

patch/v1/users/{userId}

Request

Base URL
https://api.telgea.com
Auth
API key in header x-api-key

Path parameters

userIdstring uuid required

UUID of the user.

Example:9c1f2a6e-3b7d-4e0a-8f21-5d6c7b8a9e01

Headers

idempotency-keystring

A value unique to this request, of 1 to 255 printable ASCII characters — a UUID is the usual choice. Retry with the same key within 24 hours and you get the original response back, even if it was a failure, and nothing is done twice. Send a new key whenever you change the request. Keys are private to your API key and organisation.

Example:0b7e4f1c-6a2d-4c9e-8f35-d1a7b2c93e60

Request body

emailstring email

Email address

firstNamestring

First name

lastNamestring

Last name

teamIdstring uuid nullable

Team to assign the user to. null moves the user to the default team, Unassigned.

costCodestring nullable

Cost center code for billing purposes (null to remove)

employeeIdstring nullable

External employee identifier (null to remove)

Example request

{
  "email": "anna.holm@acme.example",
  "firstName": "Anna",
  "lastName": "Holm",
  "teamId": "2f6b0d3a-8c1e-4a7f-9b2d-1e3c4d5f6a70",
  "costCode": "CC-4100",
  "employeeId": "EMP-0142"
}

Response

User updated successfully. No content returned.

Changes

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