PUT
/
users
/
{user_id}
Updates a user.
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

X-API-KEY
string
header
required

Path Parameters

user_id
string
required

ID of the user to update.

Body

application/json
name
string
required

The full name of the user. It doesn't have to be unique for the client.

Example:

"John Smith"

email
string<email>
required

The email of the user. The field does not have to be a real email address. It can be the user's identifier in your system.

Example:

"john.smith@company.com"

recurring_checks_enabled
boolean

Determines if recurring checks are enabled for this user. Overrides the same setting if present in client level configuration.

recurring_check_frequency
string

Frequency of the recurring check for this user. Overrides the same setting if present in client level configuration. Available frequencies in production are [WEEKLY, DAILY]. Sandbox allows HOURLY frequency in addition.

Example:

"WEEKLY"

recurring_check_end_date
string<date-time>

End date of the recurring check schedule. Overrides the same setting if present in client level configuration.

Example:

"2019-05-17T00:00:00.000Z"

payroll_period_months
integer

Lookback period of the payroll to search on account creation. Overrides the same setting if present in client level configuration.

Response

Updated

name
string
required

The full name of the user. It doesn't have to be unique for the client.

Example:

"John Smith"

email
string<email>
required

The email of the user. The field does not have to be a real email address. It can be the user's identifier in your system.

Example:

"john.smith@company.com"

user_id
string<uuid>
required

Unique identifier for user

created_at
string<date-time>
required

Creation time in UTC of the user

Example:

"2019-05-17T00:00:00.000Z"

recurring_checks_enabled
boolean

Determines if recurring checks are enabled for this user. Overrides the same setting if present in client level configuration.

recurring_check_frequency
string

Frequency of the recurring check for this user. Overrides the same setting if present in client level configuration. Available frequencies in production are [WEEKLY, DAILY]. Sandbox allows HOURLY frequency in addition.

Example:

"WEEKLY"

recurring_check_end_date
string<date-time>

End date of the recurring check schedule. Overrides the same setting if present in client level configuration.

Example:

"2019-05-17T00:00:00.000Z"

payroll_period_months
integer

Lookback period of the payroll to search on account creation. Overrides the same setting if present in client level configuration.