v1/users/{id}

put

https://shyftplan.com/api/v1/users/{id}

Edit a User employment.

Path Params

int32

required

Employment id.

Body Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

first_name

string

required

last_name

string

required

billing_type_id

int32

enum

1 = abrechnen (is billed); 2 = nicht abrechnen (is not billed)

Allowed:

string

(New) e-mail address of the user. Requires sso_only=true

employment_work_hour_attributes

object

entry_date

date

exit_date

date

exit_month_payed_partially

boolean

is_paid_monthly

boolean

maximum_money

float

maximum_money_enabled

boolean

max_vacation_days

float

note

string

Note saved with the object.

phone_number

string

Phone number for the employment.

restricted_shift_preset_ids

array of objects

List of shift preset IDs. The employee can't be assigned to a shift which is based on one of these presets (configurable conflict in company profile).

restricted_shift_preset_ids

sso_only

boolean

Defaults to false

Boolean flag to determine if the user must log in via SSO. Can only be changed by a super-admin

staff_number

string

tag_ids

array of objects

List of employment tag ids to be set for this employment.

tag_ids

upn

string

User Principal Name (UPN) used to sign in with Microsoft

user_token

int32

Response

200

Edit a User employment.