These docs are for v2.2023.0401. Click to read the latest docs for v2.2026.0101.

Create Role

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Minimum Plan Required: Entrée

Path Params
int64
required

The company id

Body Params
string
required

Role name

string
required

A hex number representing the color

integer
required

Location ID

integer
required

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

integer
≥ 0
Defaults to 0

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

string

Job code

stations
array of objects

Stations this role contains

stations
Headers
string
^\d{4}-\d{2}-\d{2}$

7shifts API version

uuid

Company GUID

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json