Public
Events

Publish events occurring during a specific period of time. This operation runs asynchronously and will return immediately.

post/v1/public/events/publish/period

Request

Request body

fromDatestring required

A date in ISO-8601 format (2021-01-31T20:00:00.000-05:00). Publish events which ends after this date

toDatestring required

A date in ISO-8601 format (2021-01-31T20:00:00.000-05:00). Publish events which starts before this date

forTeamIdsstring[]

If specified, use this array of team UIDs to only published events linked to those teams

forTeamCodesstring[]

If specified, use this array of team codes to only published events linked to those teams. (forTeamIds will take precedence over forTeamCodes if set)

forMemberIdsstring[]

If specified, use this array of member UIDs to only published events linked to those members

forMemberCodesstring[]

If specified, use this array of member codes to only published events linked to those members. (forMemberIds will take precedence over forMemberCodes if set)

forLocationIdsstring[]

If specified, use this array of location UIDs to only published events linked to those locations

forLocationCodesstring[]

If specified, use this array of location codes to only PUBLISH events linked to those locations. (forLocationIds will take precedence over forLocationCodes if set)

forSkillIdsstring[]

If specified, use this array of skill UIDs to only published events linked to those skills

forSkillCodesstring[]

If specified, use this array of skill codes to only PUBLISH events linked to those skills (positions). (forSkillIds will take precedence over forSkillCodes if set)

forConditionCodesConditionCode[]

If specified, use this is array of condition code to publish specific type of events

sendNotificationboolean

If true (default), notifications will be sent

Example request

{
  "fromDate": "2021-01-31T20:00:00.000-05:00",
  "toDate": "2021-01-31T20:00:00.000-05:00",
  "forTeamIds": [
    "66047859460e3cfd4c887098"
  ],
  "forTeamCodes": [
    "TEAM_!"
  ],
  "forMemberIds": [
    "66047859460e3cfd4c887098"
  ],
  "forMemberCodes": [
    "EMP_1"
  ],
  "forLocationIds": [
    "66047859460e3cfd4c887098"
  ],
  "forLocationCodes": [
    "LOC_1"
  ],
  "forSkillIds": [
    "66047859460e3cfd4c887098"
  ],
  "forSkillCodes": [
    "SKILL_1"
  ],
  "forConditionCodes": [
    "REGULAR_SHIFTS"
  ]
}

Response

The publish operation is being processed

Changes

No recorded changes to this operation across all 8 revisions of this API.