v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
employmentProfiles

Set the disabled flag for a worker case and emit activity events

patch/api/serviceemployment/processes/companies/{companyIdentifier}/profiles/all/workers/{workerIdentifier}/disabled

Path parameters

companyIdentifierstring uuid required

company unique identifier

workerIdentifierstring uuid required

worker unique identifier

Request body

disabledboolean required
endDatestring
notestring
reactivateMessagingboolean

Re-enable messaging for the worker if it was disabled

reactivateSegmentboolean

Re-include the worker in segments if they were excluded

Example request

{
  "reactivateMessaging": true,
  "reactivateSegment": true
}

Response

Worker case disabled flag successfully updated