Update User

put

https://api.7shifts.com/v2/company/{company_id}/users/{identifier}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Minimum Plan Required: Entrée

📘
Updating Users Guide
Please refer to our Update Employee Data guide for best practices and restrictions for updating user properties such as email and phone number.

Path Params

company_id

int64

required

Company ID

identifier

int64

required

User ID

Body Params

first_name

string

length ≤ 80

The user's first name

last_name

string

length ≤ 80

The user's last name

preferred_first_name

string | null

An optional alternate first name

preferred_last_name

string | null

An optional alternate last name

string

length ≤ 155

the user's email

mobile_number

string | null

The user's mobile phone number. Format with no spaces and include area code

home_number

string | null

The user's home phone number. Format with no spaces and include area code

address

string | null

The user's address

postal_zip

string | null

The user's postal code or zip code

city

string | null

The user's city

prov_state

string | null

The user's province or state

notes

string | null

Notes associated with this user

hire_date

date | null

The hire date of this user. Format YYYY-MM-DD

type

string

enum

The type of this user

Allowed:

employee_id

string | null

Either an employee ID or an ID assigned by your payroll provider that is used in your payroll export

punch_id

string | null

The punch ID they punch in/out with.

birth_date

date | null

The user's birthdate. Format YYYY-MM-DD

language

string

enum

Defaults to en

The user's preferred language. Default value is en

Allowed:

appear_as_employee

boolean

User should appear in the system as an employee. Applies to admin users only

subscribe_to_updates

boolean

Subscribe this user to updates from 7shifts. This includes announcing new features for 7shifts

max_weekly_hours

number | null

The maximum weekly hours this user is set to work

active

boolean

User status. If false the user is unable to login

pronouns

string | null

The user's pronouns

permissions_template_id

integer | null

Permission Template ID the user is assigned to

skill_level

integer | null

enum

Defaults to 2

Allowed:

invite

boolean

If true, an invite will be sent to the user

wage_type

string

enum

Whether the user is paid hourly or weekly

Allowed:

show_copy_previous_dialog

boolean

This setting enables or disables the modal that appears when copying a schedule

push

boolean

If the user should receive mobile push notifications. Must have the 7shifts mobile app installed and logged in.

sms_notifications

boolean

If the user should receive SMS notifications

Headers

x-api-version

string

7shifts API version

x-company-guid

uuid

Company GUID

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not found

422Unprocessable Entity

500Server Error