Update User Deprecate

Deprecated

PUT

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

PUT

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

$ curl -X PUT https://qa.creha.co/api/v5/rest/org/organization_slug/users/1/ \
>      -H "Secret-Access: Secret-Access" \
>      -H "Api-Key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "first_name": "John",
>   "last_name": "Doe",
>   "area_level_1_id": 1,
>   "position_id": 1,
>   "position_category_id": 1,
>   "permission_group_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 Falsa 123",
>   "city": "Bogota",
>   "country": "Colombia",
>   "deactivation_date": "2022-12-31",
>   "incorporation_date": "2021-12-31"
> }'

1 {
2   "message": "User created",
3   "code": "ok-001",
4   "datetime": "2021-10-08T16:23:05.000000",
5   "data": {
6     "id": 1,
7     "first_name": "John",
8     "last_name": "Doe",
9     "email": "jhondoe@example.com"
10   }
11 }

Updates an existing user in the organization.

Authentication

Api-Keystring

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

Path parameters

idintegerRequired

organization_slugstringRequired

Query parameters

versionintegerOptionalDefaults to 1

Request

This endpoint expects an object.

first_namestringRequired

First name of the user

last_namestringRequired

Last name 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

permission_group_idstringOptional

Id of the permission group

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_typestringOptional

Document type of the user

documentstringOptional

Document of the user

genderstringOptional

Gender of the user

civil_statusstringOptional

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

countrystringOptional

Country of the user

deactivation_datestringOptional

Deactivation date of the user. Accepts dd/mm/yyyy or yyyy-mm-dd; it is normalized to yyyy-mm-dd.

incorporation_datestringOptional

Incorporation date of the user. Accepts dd/mm/yyyy or yyyy-mm-dd; it is normalized to yyyy-mm-dd.

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