Skip to main content

Create user

This endpoint allows you to create a new user.

Endpoint

POST /user/v1/users

Parameters

NameLocationRequiredTypeDefault valueDescription
customer_idBodyYesIntegerThe customer identifier to which the user belongs.
firstnameBodyYesStringUser firstname
lastnameBodyYesStringUser lastname
emailBodyYesStringUser email
expires_atBodyNoDate2099-12-31User expiration date
phoneBodyNoStringUser phone number
languageBodyYesStringUser language.
Allowed values : en, fr, de

Response

A User object.

Example Request

POST /user/v1/users
Body
{
"lastname": "Doe",
"firstname": "John",
"email": "john.doe@company.fr",
"customer_id": 1234,
"phone": "+33612345678",
"language": "fr"
}

Example Response

{
"message": "OK",
"data": {
"id": "c0b48140-34cb-4187-acd7-aaa830dc97f9",
"firstname": "John",
"lastname": "Doe",
"email": "john.doe@company.com",
"language": "fr",
"phone": "+33612345678",
"customer_id": 1234,
"expires_at": "2099-12-31",
"last_login_at": null,
"created_at": "2023-01-01T00:00:00+01:00",
"created_by": {
"id": "7a1506b9-9ce4-43f9-a6f0-e94ef4252277",
"firstname": "Company",
"lastname": "Administrator"
},
"updated_at": "2023-01-01T00:00:00+01:00",
"updated_by": {
"id": "7a1506b9-9ce4-43f9-a6f0-e94ef4252277",
"firstname": "Company",
"lastname": "Administrator"
}
}
}