Sign in
Public
Events

Update an existing event. The id can be an UID or an externalId

patch/v1/public/events/{eventId}

Path parameters

eventIdstring required

Request body

startsAtstring

the start date and time of the event. In ISO-8601 format.

endsAtstring

the end date and time of the event. In ISO-8601 format. The total event duration is 24 hours max.

timeZonestring

event time zone

hideEndsAtboolean

if true the event has an undetermined end time. endsAt is still initialised but represent a suggested end time

skillIdstring required

the event skill(position) UID. Can use the skillCode or the skillId (skillId will take precedence over skillCode if set)

skillCodestring required

the event skill(position) code. Can use the skillCode or the skillId (skillId will take precedence over skillCode if set)

teamIdstring required

the event team UID. Can use the teamCode or the teamId (teamId will take precedence over teamCode if set)

teamCodestring required

the event team code. Can use the teamCode or the teamId (teamId will take precedence over teamCode if set)

locationIdstring

the event location UID. Can use the locationCode or the locationId (locationId will take precedence over locationCode if set)

locationCodestring

the event location code. Can use the locationCode or the locationId (locationId will take precedence over locationCode if set)

subLocationIdstring

the event sub-location UID. Can use the subLocationCode or the subLocationId (subLocationId will take precedence over subLocationCode if set)

subLocationCodestring

the event sub-location code. Can use the subLocationCode or the subLocationId (subLocationId will take precedence over subLocationCode if set)

notestring

This note is visible to the assigned employee and to shift team managers

internalNotestring

The internalNote field is a private property restricted to shift team managers. This information is never visible to the assigned employee.

premiumCodesstring[]

Array of premium codes to apply on the event. If set, premiumIds will take precedence over premiumCodes.

premiumIdsstring[]

Array of premium ids to apply on the event. If set, premiumIds will take precedence over premiumCodes.

externalIdstring

The externalId is an optional, user-defined string that allows you to map objects in our system to records within your own external database or third-party application. This value is not validated or used by our internal application logic. It serves strictly as a metadata bridge for your integration. This is a searchable field but since our system does not enforce uniqueness on this field, we recommend using unique values to ensure your integration can reliably find records using your own identifiers

Example request

{
  "timeZone": "America/New_York",
  "premiumCodes": [
    "premiumCode1",
    "premiumCode2"
  ],
  "premiumIds": [
    "premiumId1",
    "premiumId2"
  ]
}

Response

uidstring required

unique event id

externalIdstring

The unique event externalId. The externalId is often used as a mapping value between Evolia and an external system

startsAtstring required

date and time of the start of the event. In ISO-8601 format.

endsAtstring required

date and time of the end of the event. In ISO-8601 format.

hideEndsAtboolean required

if true the event has an undetermined end time. endsAt is still initialised but represent more a suggested end time

timeZonestring required

event time zone, ex: America/New_York

memberFirstNamestring

when assigned, contains the member (employee) first name

memberLastNamestring

when assigned, contains the member (employee) first name

memberIdstring

when assigned, contains the member (employee) UID

memberCodestring

when assigned, contains the member (employee) code

memberHourlyWagenumber

when assigned, contains the member hourly wage specific to the skill of the shift

openShiftCountnumber

a shift is considered open when memberId is undefined. When a shift is open, openShiftCount indicates the number of places available

skillIdstring required

the event skill UID (position)

skillNamestring required

the event skill name (position)

skillCodestring

the event skill code (position)

locationIdstring

the event location UID

locationNamestring

the event location name

locationCodestring

the event location code

subLocationIdstring

the event sub-location UID

subLocationNamestring

the event sub-location name

subLocationCodestring

the event sub-location code

divisionIdstring

the event division UID

teamIdstring required

the event team UID

teamCodestring

the event team code

teamNamestring

the event team name

isStandbyboolean

if true this event is in stand-by

isCancelledboolean

if true this event is cancelled

cancelledReasonstring

the reason of the cancellation

isDraftboolean required

if true this event is draft

notestring

This note is visible to the assigned employee and to shift team managers

internalNotestring

The internalNote field is a private property restricted to shift team managers. This information is never visible to the assigned employee.

paidPreparationTimeInMnumber required

The paid preparation time in minutes.

assignedByobject required

when assigned, member (employee) UID that assigned the event.

assignedAtstring required

when assigned, date and time of the assignment of the event. In ISO-8601 format.

splitFromEventIdstring required

when event is split from another event, contains the source event UID

Example response

{
  "premiums": [
    {
      "names": {
        "en": "night bonus",
        "fr": "prime de nuit"
      },
      "calculationType": "AMOUNT: flat amount (+ 15$), HOURS: flat amount of hours (+ 1h), HOURLY_MULTIPLIER: multiply hourly rate (x 1.5/h), HOURLY_BONUS: flat hourly bonus (+ 1$/h)",
      "code": "241"
    }
  ]
}

Changes

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