delete_participant
Remove a participant from a Pega case by providing case ID, participant ID, and eTag for optimistic locking to ensure data consistency. Returns success confirmation or error details.
Instructions
Delete a participant from a Pega case by case ID and participant ID. Requires an eTag value for optimistic locking to ensure data consistency. Returns success confirmation or detailed error information.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| caseID | Yes | Full case handle (case ID) to remove participant from. Example: "ON6E5R-DIYRecipe-Work-RecipeCollection R-1008". Must be a complete case identifier including spaces and special characters. | |
| eTag | Yes | Required eTag unique value for optimistic locking. This must be obtained from a previous GET request (get_participant, get_case_participants, etc.) and represents the current state of the participant data. Used to prevent concurrent modification conflicts. | |
| participantID | Yes | Participant ID to remove from the case. This identifies the specific participant that will be deleted from the case participant list. |
Input Schema (JSON Schema)
{
"properties": {
"caseID": {
"description": "Full case handle (case ID) to remove participant from. Example: \"ON6E5R-DIYRecipe-Work-RecipeCollection R-1008\". Must be a complete case identifier including spaces and special characters.",
"type": "string"
},
"eTag": {
"description": "Required eTag unique value for optimistic locking. This must be obtained from a previous GET request (get_participant, get_case_participants, etc.) and represents the current state of the participant data. Used to prevent concurrent modification conflicts.",
"type": "string"
},
"participantID": {
"description": "Participant ID to remove from the case. This identifies the specific participant that will be deleted from the case participant list.",
"type": "string"
}
},
"required": [
"caseID",
"participantID",
"eTag"
],
"type": "object"
}