v1/shiftplans/{id}/publish

post

https://shyftplan.com/api/v1/shiftplans/{id}/publish

Publish Shiftplan.

Path Params

int32

required

Shiftplan ID.

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.

message

string

Defaults to null

Publish message when send_message is true

publish_with_email

boolean

Defaults to false

Publish with email

send_assigned_shifts

boolean

Defaults to false

Send assigned shifts when publish_with_email is true

send_message

boolean

Defaults to false

Send a message when publish_with_email is true

send_open_shifts

boolean

Defaults to false

Send open shift when publish_with_email is true

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Success

401Unauthorized

403Forbidden

404Shiftplan not found\nCompany not found

422Invalid transition