Sign in

v1

latestOpenAPI 3.0.22026-07-24154101.1 MB
Roles

Create Role

post/v2/company/{company_id}/roles

Path parameters

company_idinteger required

The company id

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Request body

namestring required

Role name

colorstring required

A hex number representing the color

location_idinteger required

Location ID

department_idinteger required

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

job_codestring

Job code

is_tipped_roleboolean

When true, role is tipped. Otherwise the role is non tipped

Response

Created

object'role' required

Example response

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