Skip to content
ShiftSync Developers

Create a pay-enhancement rule

Creates a pay-enhancement rule.

POST
/v1/pay/rules
curl --request POST \
  --url https://api.shiftsync.app/v1/pay/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "string", "priority": 0, "daysOfWeek": [ 0 ], "startTime": null, "endTime": null, "kind": "percentage", "amount": 0, "enabled": true }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters
priority
required
integer
>= -9007199254740991 <= 9007199254740991
daysOfWeek
Array<integer>
startTime
string
nullable
endTime
string
nullable
kind
required
string
Allowed values: percentage fixed
amount
required
integer
<= 9007199254740991
enabled
boolean
default: true
Example
{
  "name": "string",
  "priority": 0,
  "daysOfWeek": [
    0
  ],
  "startTime": null,
  "endTime": null,
  "kind": "percentage",
  "amount": 0,
  "enabled": true
}

Responses

Section titled “Responses”

201

Section titled “201”

The created rule

Media typeapplication/json
object
item
required
object
id
required
integer
>= -9007199254740991 <= 9007199254740991
name
required
string
priority
required
integer
>= -9007199254740991 <= 9007199254740991
daysOfWeek
required
Array
startTime
required
string
nullable
endTime
required
string
nullable
kind
required
string
Allowed values: percentage fixed
amount
required
integer
>= -9007199254740991 <= 9007199254740991
enabled
required
boolean
Example
{
  "item": {
    "id": 0,
    "name": "string",
    "priority": 0,
    "daysOfWeek": [
      0
    ],
    "startTime": "string",
    "endTime": "string",
    "kind": "percentage",
    "amount": 0,
    "enabled": true
  }
}