Skip to main content

Update a client

Updates the specified client by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Parameters​

color
string
Color for the user in hex.
email
string
Email address of the user.
language
enum
ISO code of the user language.
name
string
Name of the user.
title
nullable string
Job title of the user.
timezone
enum
Valid timezone of the user.
username
string
Unique username of the user.

Returns​

Returns the client user object if the update succeeded. Throws an error if update parameters are invalid.

put
/api/clients/{id}
curl -X PUT https://{workspace}.kitchen.co/api/clients/{id} \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "created_at": "2024-03-11T15:37:23+00:00",
  "email": "john.doe@example.net",
  "group": "client",
  "id": "u_c01bb6102b6ddadd4b1f020e",
  "language": null,
  "name": "John Doe",
  "phone": null,
  "role": "member",
  "timezone": null,
  "title": null,
  "updated_at": "2024-03-11T15:37:23+00:00",
  "username": "johndoe"
}