Skip to main content

Create a client

Create a client.

Parameters​

email
string
required
Email address of the user.
name
string
required
Name of the user.
password
string
The password for the user is optional. If the client is created without password, it will be able to login only via email.
title
string
Job title of the user.

Returns​

Returns the created client user object. Throws an error if some parameters are not valid.

post
/api/clients
curl -X POST https://{workspace}.kitchen.co/api/clients \
    -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"
}