v1

latestOpenAPI 3.0.22026-07-24154101.1 MB

Users

Update User

put/v2/company/{company_id}/users/{identifier}

Path parameters

company_idinteger required

Company ID

identifierinteger required

User ID

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Request body

first_namestring

The user's first name

last_namestring

The user's last name

preferred_first_namestring nullable

An optional alternate first name

preferred_last_namestring nullable

An optional alternate last name

emailstring

the user's email

mobile_numberstring nullable

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

home_numberstring nullable

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

addressstring nullable

The user's address

postal_zipstring nullable

The user's postal code or zip code

citystring nullable

The user's city

prov_statestring nullable

The user's province or state

notesstring nullable

Notes associated with this user

hire_datestring date nullable

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

type'employee' | 'asst_manager' | 'manager'

The type of this user

employee_idstring nullable

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

punch_idstring nullable

The punch ID they punch in/out with.

birth_datestring date nullable

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

language'en' | 'es' | 'fr'

The user's preferred language. Default value is en

appear_as_employeeboolean

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

subscribe_to_updatesboolean

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

max_weekly_hoursnumber nullable

The maximum weekly hours this user is set to work

activeboolean

User status. If false the user is unable to login

pronounsstring nullable

The user's pronouns

permissions_template_idinteger nullable

Permission Template ID the user is assigned to

skill_level1 | 2 | 3 nullable

inviteboolean

If true, an invite will be sent to the user

wage_type'hourly' | 'weekly_salary'

Whether the user is paid hourly or weekly

show_copy_previous_dialogboolean

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

pushboolean

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

sms_notificationsboolean

If the user should receive SMS notifications

Example request

{
  "email": "example@7shifts.com",
  "hire_date": "2017-05-20",
  "birth_date": "2017-07-21"
}

Response

object'user' required

Example response

{
  "data": {
    "timezone": "America/Chicago",
    "language": "en",
    "skill_level": 2,
    "wage_type": "salary"
  }
}