Update 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

first_name

string

required

The person's first name

last_name

string

required

The person's last name

string

required

The person's email address

cell

The person's cell phone number

notifications_text

Whether person opts in to SMS communications

notifications_slack

Whether person opts in to Slack communications

notifications_email

Whether person opts in to email communications

sms_disabled

Whether person has disabled SMS communications through Twilio specifically

enable_login

Enable login for this person

employee_id

The person's employee ID

external_id

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

wise_recipient_id

The person's Recipient ID from Wise

wise_recipient_currency

The person's Recipient Currency from Wise

inactive

Whether provider is currently active in Planbase

archived

Whether provider is archived in Planbase

timezone

The timezone where the person works.

start_date

The start date of the person's employment

employment_end_date

The date when the person's employment ended

employment_type

null

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

custom_option_ids

array | null

List of custom option IDs associated with the person

exempt

Whether the person is exempt from overtime

rate

The person's pay rate

rate_type

null

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

employment_classification

null

The person's employment classification, e.g. W2, 1099

regular_work_hours

object | null

The person's regular work hours as a JSON object

notes

The person's notes

submits_availability

Whether the person submits their availability

submits_unavailability

Whether the person submits unavailability

access_level_type

The person's access level

min_daily_hours

Minimum contracted daily hours

max_daily_hours

Maximum contracted daily hours

min_weekly_hours

Minimum contracted weekly hours

max_weekly_hours

Maximum contracted weekly hours

weekday_start

null

Weekday start

min_monthly_hours

Minimum contracted monthly hours

max_monthly_hours

Maximum contracted monthly hours

weekends_month

Minimum contracted weekends per month

flex_hours

Whether the person's shifts are flexible

pay_cycle_id

The ID of the person's pay cycle

pay_cycle_name

The name of the person's pay cycle

saved_filters

object | null

The person's saved filters

team_ids

array | null

List of team IDs the person is a member of

role_ids

array | null

List of role IDs the person can perform

client_assignments_in

array | null

List of client assignments that this person has

manager_assignments_in

array | null

List of teams and roles this person manages

licenses_in

array | null

List of new licenses that this person has

payor_enrollments_in

array | null

List of payor enrollments that this person has

occurrences_in

array | null

List of occurrences (notable events or incidents) for this person

custom_fields

object | null

List of custom fields that this person has

unavailability_allowances_in

array | null

List of unavailability allowances that this person has

unavailability_balances_in

array | null

List of unavailability balances that this person has

team_propogation

role_propogation

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error