v1/employments_rotation_groups/{id}

put

https://shyftplan.com/api/v1/employments_rotation_groups/{id}

Update an employments-shift-system group.

Path Params

int32

required

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

≥ 1

ID of a shyftplan account.

starts_at

date-time

Valid from date-time of an employment-shift-system-group.

ends_at

date-time

Employment-shift-system-group ends at.

strategy_to_unassign_from_shifts

string

enum

When you provide ends_at, you can request to unassign the employee from shifts after that date. There are two strategies: all and rotation_group. With all, the employee is unassigned from all shifts after end_at. With rotation_group, the employee is unassigned from all shifts of the shift-system group after ends_at. The unassignment happens as a background job.

Allowed:

ignore_conflicts

boolean

Defaults to false

Perform the update in the presence of conflicts.

Responses

200Successfully updated

403forbidden

404Shift-system group not found

422The request is invalid