Update Role

put

https://api.7shifts.com/v2/company/{company_id}/roles/{role_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Minimum Plan Required: Entrée

Path Params

company_id

int64

required

Company ID

role_id

int64

required

Role ID

Body Params

department_id

integer

Defaults to 0

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

sort

integer

≥ 0

Defaults to 0

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

color

string

length ≤ 6

A hex number representing the color

name

string

length ≤ 155

Role name

job_code

string

length ≤ 190

Job code

stations

array of objects

Stations this role contains

stations

is_tipped_role

boolean

Defaults to false

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

Headers

x-api-version

string

^\d{4}-\d{2}-\d{2}$

7shifts API version

x-company-guid

uuid

Company GUID

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

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

application/json

application/problem+json

200OK

400Bad Request

403Forbidden

404Not found

422Unprocessable Entity

500Server Error