update_participant

Modify participant details in a Pega case using case ID and participant ID. Update contact information, personal data, or other properties. Requires an eTag for optimistic locking and optionally returns UI resources for display.

Instructions

Update participant details in a Pega case by case ID and participant ID. Allows updating participant information such as contact details, personal information, and other properties. Requires an eTag value for optimistic locking and returns updated participant details with optional UI resources.

Input Schema

Name	Required	Description	Default
`caseID`	Yes	Full case handle (case ID) containing the participant to update. Example: "ON6E5R-DIYRecipe-Work-RecipeCollection R-1008". Must be a complete case identifier including spaces and special characters.
`content`	No	Optional participant data object with properties to update. Can include personal information like pyFirstName, pyLastName, pyEmail1, pyPhoneNumber, etc. Only provided properties will be updated - others remain unchanged.
`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.
`pageInstructions`	No	Optional page-related operations for embedded pages, page lists, or page groups. Used for complex data structure manipulation within the participant record.
`participantID`	Yes	Participant ID to update. This identifies the specific participant within the case whose information will be modified.
`viewType`	No	Type of view data to return after update. "form" returns form UI metadata in uiResources object for display purposes, "none" returns no UI resources. Default: "form".	form

Input Schema (JSON Schema)

{
  "properties": {
    "caseID": {
      "description": "Full case handle (case ID) containing the participant to update. Example: \"ON6E5R-DIYRecipe-Work-RecipeCollection R-1008\". Must be a complete case identifier including spaces and special characters.",
      "type": "string"
    },
    "content": {
      "description": "Optional participant data object with properties to update. Can include personal information like pyFirstName, pyLastName, pyEmail1, pyPhoneNumber, etc. Only provided properties will be updated - others remain unchanged.",
      "properties": {
        "pyEmail1": {
          "description": "Primary email address of the participant",
          "type": "string"
        },
        "pyFirstName": {
          "description": "First name of the participant",
          "type": "string"
        },
        "pyFullName": {
          "description": "Full name of the participant",
          "type": "string"
        },
        "pyLastName": {
          "description": "Last name of the participant",
          "type": "string"
        },
        "pyPhoneNumber": {
          "description": "Phone number of the participant",
          "type": "string"
        },
        "pyTitle": {
          "description": "Title or position of the participant",
          "type": "string"
        }
      },
      "type": "object"
    },
    "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"
    },
    "pageInstructions": {
      "description": "Optional page-related operations for embedded pages, page lists, or page groups. Used for complex data structure manipulation within the participant record.",
      "items": {
        "description": "Page instruction object for embedded page operations",
        "type": "object"
      },
      "type": "array"
    },
    "participantID": {
      "description": "Participant ID to update. This identifies the specific participant within the case whose information will be modified.",
      "type": "string"
    },
    "viewType": {
      "default": "form",
      "description": "Type of view data to return after update. \"form\" returns form UI metadata in uiResources object for display purposes, \"none\" returns no UI resources. Default: \"form\".",
      "enum": [
        "form",
        "none"
      ],
      "type": "string"
    }
  },
  "required": [
    "caseID",
    "participantID",
    "eTag"
  ],
  "type": "object"
}

Pega DX MCP Server