DEdeputy
Shifts

Publish shifts (asynchronous)

Publishes shifts to make them visible to employees and optionally sends notifications. This is an asynchronous API that returns immediately with an operation ID in the response metadata.operation.operationId field. Use the operation ID to poll the /operations/v2/operations/{id} endpoint to check completion status. The publish operation marks shifts as published and sends notifications based on the specified notification mode.

post/management/v2/shifts:publish

Request

  • Base URL
    https://your-subdomain.deputy.deputy.com/api
  • URL
    https://your-subdomain.deputy.deputy.com/api/management/v2/shifts:publish
  • Auth
    API key in header OAuth

Request body

shiftIdsinteger[]
notificationMode'PUBLISH_NOTIFICATION_NONE' | 'PUBLISH_NOTIFICATION_SMS' | 'PUBLISH_NOTIFICATION_EMAIL_PUSH' | 'PUBLISH_NOTIFICATION_SMS_EMAIL_PUSH' | 'PUBLISH_NOTIFICATION_SMS_CONFIRM'
  • PUBLISH_NOTIFICATION_NONE: No notifications
  • PUBLISH_NOTIFICATION_SMS: SMS only
  • PUBLISH_NOTIFICATION_EMAIL_PUSH: Email and Push only
  • PUBLISH_NOTIFICATION_SMS_EMAIL_PUSH: SMS, Email, and Push notifications
  • PUBLISH_NOTIFICATION_SMS_CONFIRM: SMS with confirmation required
isAllLocationsModeboolean
forceboolean
startstring
endstring

Response

A successful response.

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.