Users
Update a User
Update a user and its config. If a field is sent as null then it is considered an unset or removal.
PUT
/
users
/
{user_id}
curl --request PUT \
--url https://api.sandbox.goteal.co/users/{user_id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"name": "John Smith",
"email": "john.smith@company.com",
"recurring_checks_enabled": true,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2019-05-17T00:00:00.000Z",
"payroll_period_months": 123
}'{
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2019-05-17T00:00:00.000Z",
"name": "John Smith",
"email": "john.smith@company.com",
"recurring_checks_enabled": true,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2019-05-17T00:00:00.000Z",
"payroll_period_months": 123
}Authorizations
Path Parameters
ID of the user to update.
Body
application/json
Response
200
application/json
Updated
The response is of type object.
curl --request PUT \
--url https://api.sandbox.goteal.co/users/{user_id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"name": "John Smith",
"email": "john.smith@company.com",
"recurring_checks_enabled": true,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2019-05-17T00:00:00.000Z",
"payroll_period_months": 123
}'{
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2019-05-17T00:00:00.000Z",
"name": "John Smith",
"email": "john.smith@company.com",
"recurring_checks_enabled": true,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2019-05-17T00:00:00.000Z",
"payroll_period_months": 123
}