Sign in

v1

latestOpenAPI 3.0.22026-07-24154101.1 MB
Roles

Update Role

put/v2/company/{company_id}/roles/{role_id}

Path parameters

company_idinteger required

Company ID

role_idinteger required

Role ID

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Request body

department_idinteger

Department ID. If this role is not assigned to a department, this value will be zero

sortinteger

The order in which the roles will be listed in the web app

colorstring

A hex number representing the color

namestring

Role name

job_codestring

Job code

is_tipped_roleboolean

When zero, role is a non tipped role, when one, role is tipped role

Example request

{
  "color": "76a939",
  "name": "Bartender",
  "job_code": "BOH-Bartender"
}

Response

OK

object'role' required

Example response

{
  "data": {
    "created": "2021-01-01T00:00:00.000Z",
    "modified": "2021-01-01T00:00:00.000Z"
  }
}