Create User

POST

/api/v5/rest/org/:organization_slug/users/

POST

/api/v5/rest/org/:organization_slug/users/

$ curl -X POST https://qa.creha.co/api/v5/rest/org/organization_slug/users/ \
>      -H "Secret-Access: Secret-Access" \
>      -H "Api-Key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "first_name": "John",
>   "last_name": "Doe",
>   "email": "jhondoe@example.com",
>   "area_level_1_id": 1,
>   "position_id": 1,
>   "position_category_id": 1,
>   "area_level_2_id": 1,
>   "area_level_3_id": 1,
>   "area_level_4_id": 1,
>   "headquarter_id": 1,
>   "boss_email": "boss@example.com",
>   "boss_id": 1,
>   "document_type": "id",
>   "document": "123456789",
>   "gender": "men",
>   "civil_status": "single",
>   "phone_1": "123456789",
>   "phone_2": "123456789",
>   "address": "Calle Siempre Viva 123",
>   "city": "Bogota",
>   "country": "CO",
>   "deactivation_date": "2025-05-06",
>   "incorporation_date": "1993-05-06"
> }'

1 {
2   "message": "User created successfully.",
3   "code": "users-004",
4   "datetime": "2024-01-15T10:30:00.000000",
5   "data": {
6     "id": 1,
7     "first_name": "John",
8     "last_name": "Doe",
9     "email": "john@example.com",
10     "is_active": true,
11     "created_at": "2024-01-15T10:30:00",
12     "username": "johndoe"
13   }
14 }

Purpose: This endpoint allows you to create users in the Crehana platform, including their personal information and organizational structure.
Scope: Create user data on the platform for a Centralized, Learning & Talent.

Authentication

Api-Keystring

API key of the organization. Always sent together with the Secret-Access header.

Path parameters

organization_slugstringRequired

Request

This endpoint expects an object.

first_namestringRequired

First name of the user

last_namestringRequired

Last name of the user

emailstringRequired

Email of the user

area_level_1_idintegerRequired

Id of the organization direction (Area level 1)

position_idintegerRequired

Id of the position related to the user

position_category_idintegerRequired

Id of the position category

area_level_2_idintegerOptional

Id of the organization department (Area level 2)

area_level_3_idintegerOptional

Id of the organization office (Area level 3)

area_level_4_idintegerOptional

Id of the organization suboffice (Area level 4)

headquarter_idintegerOptional

Id of the organization headquarter

boss_emailstringOptional

Email of the user's boss

boss_idintegerOptional

User id of the user's boss

document_typeenumOptional

Document type of the user

documentstringOptional

Document of the user

genderenumOptional

Gender of the user

civil_statusenumOptional

Civil status of the user

phone_1stringOptional

Phone number 1 of the user

phone_2stringOptional

Phone number 2 of the user

addressstringOptional

Address of the user

citystringOptional

City of the user

countryenumOptional

Country of the user

deactivation_datedateOptional

Deactivation date of the user in format YYYY-MM-DD

incorporation_datedateOptional

Incorporation date of the user in format YYYY-MM-DD

birth_datedateOptional

Birth date of the user in format YYYY-MM-DD

send_invitationbooleanOptional

If the value is true, it will send an activation invitation to the user's email.

usernamestringOptional

Username of the user

Response

Successful Response

messagestring

Message of the response

codestring

Internal code of the response

datetimestring

Datetime of the API in ISO Format

dataobjectOptional

Errors

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Request

Response

Errors