RemoveAgentFromFutureShifts

POST

https://api.cbf.tcn.com/api/v1alpha1/wfm/removeagentfromfutureshifts

Removes the @wfm_agent_sid_to_remove from all future shifts for the org.
If @replace_with_new_unassigned_agent is set to true, a new unassigned agent will be created and it will be assigned to the shifts and agent groups from @wfm_agent_sid_to_remove.
If @replace_with_new_unassigned_agent is set to false, the future shifts will just be deleted.
If the @wfm_agent_sid_to_remove is not currently inactive, it will be set as inactive.
Errors:

grpc.Internal: error occurs when deleting the shifts, creating the new unassigned agent, reassigning the shifts to that agent, or setting the agent to inactive.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "wfm_agent_sid_to_remove": 0,
    "replace_with_new_unassigned_agent": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/wfm/removeagentfromfutureshifts' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "wfm_agent_sid_to_remove": 0,
    "replace_with_new_unassigned_agent": true
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "unassigned_agent_sid": "string"
}

🟢200Success

Modified at 2025-09-26 15:44:58

DeleteWFMAgentsMemberships

BuildAgentDiagnostics