v1/tags

post

https://shyftplan.com/api/v1/tags

Create a new tag to be used on shifts. The shift tag name must be globally unique, so you cannot create a location-specific shift tag if a shift tag of the same name (global or location-specific for any location) exists already. You can replace an existing location-specific shift tag by creating a global shift tag of the same name.

Body Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

location_id

int32

ID of a location. To create a global tag, omit this parameter (or set it to null). Required if you want to create a location-specific shift-tag.

name

string

required

Name

color

string

Color (HEX format, e.g. #FF00FF)

force_replace

boolean

Defaults to false

Boolean value to use when creating a global shift tag. Requires super-admin rights. When using it while creating a location-specific shift tag, this parameter has to be omitted or set to false. Available options:

true: Replace an existing location-specific shift tag of the same name. This will also replace replace the old tag with the new, global one on all shifts that use the old tag.
false: Only create the global shift tag if no location-specific shift tag of this name exists. Will respond with an error in case a location-specific shift tag exists. In this case, no shift tag is created.

metadata

string

Tag metadata json

Responses

201Success

401401 Unauthorized

403Forbidden

404Company not found

422Invalid request