Update an existing person

put

https://api.joinplanbase.com/api/v1/people/{id}

Update an existing person with the specified ID and details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The ID of the person to update

Body Params

access_level_type

string | null

Defaults to staff

The person's access level

archived

boolean | null

Defaults to false

Whether provider is archived in Planbase

cell

string | null

The person's cell phone number

client_assignments_in

array of objects | null

List of client assignments that this person has

Client Assignments In

custom_fields

object | null

List of custom fields that this person has

custom_option_ids

array of integers | null

List of custom option IDs associated with the person

Custom Option Ids

string

required

The person's email address

employee_id

string | null

The person's employee ID

employment_end_date

date | null

The date when the person's employment ended

employment_type

string

The person's employment type, e.g. full-time or part-time

enable_login

boolean | null

Defaults to false

Enable login for this person

exempt

boolean | null

Whether the person is exempt from overtime

external_id

string | null

The person's ID from an external system e.g payroll

first_name

string

required

The person's first name

flex_hours

boolean | null

Defaults to false

Whether the person's shifts are flexible

inactive

boolean | null

Defaults to false

Whether provider is currently active in Planbase

last_name

string

required

The person's last name

licenses_in

array of objects | null

List of new licenses that this person has

Licenses In

manager_assignments_in

array of objects | null

List of teams and roles this person manages

Manager Assignments In

max_daily_hours

integer | null

Maximum contracted daily hours

max_monthly_hours

integer | null

Maximum contracted monthly hours

max_weekly_hours

integer | null

Maximum contracted weekly hours

min_daily_hours

integer | null

Minimum contracted daily hours

min_monthly_hours

integer | null

Minimum contracted monthly hours

min_weekly_hours

integer | null

Minimum contracted weekly hours

notes

string | null

The person's notes

notifications_email

boolean | null

Defaults to true

Whether person opts in to email communications

notifications_slack

boolean | null

Defaults to true

Whether person opts in to Slack communications

notifications_text

boolean | null

Defaults to true

Whether person opts in to SMS communications

pay_cycle_id

integer | null

The ID of the person's pay cycle

pay_cycle_name

string | null

The name of the person's pay cycle

rate

number | null

The person's pay rate

rate_type

string

The person's rate type e.g. hourly or salary

regular_work_hours

object | null

The person's regular work hours as a JSON object

role_ids

array of integers | null

List of role IDs the person can perform

Role Ids

role_propogation

string | null

saved_filters

object | null

The person's saved filters

start_date

date | null

The start date of the person's employment

submits_availability

boolean | null

Whether the person submits their availability

submits_unavailability

boolean | null

Whether the person submits unavailability

team_ids

array of integers | null

List of team IDs the person is a member of

Team Ids

team_propogation

string | null

timezone

string | null

The timezone where the person works.

unavailability_allowances_in

array of objects | null

List of unavailability allowances that this person has

Unavailability Allowances In

unavailability_balances_in

array of objects | null

List of unavailability balances that this person has

Unavailability Balances In

weekday_start

string

Weekday start

weekends_month

integer | null

Minimum contracted weekends per month

wise_recipient_currency

string | null

The person's Recipient Currency from Wise

wise_recipient_id

string | null

The person's Recipient ID from Wise

Responses

200Successful Response

422Validation Error