participants

participants add

Add a participant to a case in a given role

Usage

pega participants add <caseId> [flags]

Source endpoint: POST /cases/{caseID}/participants — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--role	option	Yes		Participant role ID (e.g. Customer, Owner)
--data	option	Yes		JSON content page: {pyFirstName,pyLastName,pyEmail1,pyPhoneNumber,...} (inline, @file, or -)

Examples

pega participants add MYAPP-CASE-1 --role Customer --data '{"pyFirstName":"Jane","pyLastName":"Doe","pyEmail1":"jane@example.com","pyPhoneNumber":""}'

participants delete

Remove a participant from a case

Usage

pega participants delete <caseId> [flags]

Source endpoint: DELETE /cases/{caseID}/participants/{participantID} — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--participant-id	option	Yes		Participant instance ID

Examples

pega participants delete MYAPP-CASE-1 --participant-id PEGA-PART-X

participants get

Get a specific participant by participant ID

Usage

pega participants get <caseId> [flags]

Source endpoint: GET /cases/{caseID}/participants/{participantID} — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--participant-id	option	Yes		Participant instance ID

Examples

pega participants get MYAPP-CASE-1 --participant-id PEGA-PART-X

participants get-role

Get details of a specific participant role on a case

Usage

pega participants get-role <caseId> [flags]

Source endpoint: GET /cases/{caseID}/participant_roles/{participant_role_ID} — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--role-id	option	Yes		Participant role ID

Examples

pega participants get-role MYAPP-CASE-1 --role-id Owner

participants list

List all participants on a case

Usage

pega participants list <caseId> [flags]

Source endpoint: GET /cases/{caseID}/participants — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega participants list MYAPP-CASE-1

participants list-roles

List participant roles configured on a case

Usage

pega participants list-roles <caseId> [flags]

Source endpoint: GET /cases/{caseID}/participant_roles — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile

Examples

pega participants list-roles MYAPP-CASE-1

participants update

Update a participant's details

Usage

pega participants update <caseId> [flags]

Source endpoint: PATCH /cases/{caseID}/participants/{participantID} — view command source

Arguments

Argument	Required	Description
caseId	Yes	Case ID

Flags

Flag	Type	Required	Default	Description
--format	option	No	json	Output format (json, compact, yaml, table)
--fields	option	No		Comma-separated top-level fields to include in output
--dry-run	boolean	No		Print HTTP request details and exit without executing
--quiet	boolean	No		Suppress all stderr progress/warning output
--verbose	boolean	No		Emit full HTTP request/response details to stderr
--no-cache	boolean	No		Bypass token file cache; perform fresh OAuth exchange
--profile	option	No	default	Named config profile
--participant-id	option	Yes		Participant instance ID
--data	option	No		JSON content (inline, @file, or -)
--page-instructions	option	No		JSON page-instructions array
--attachments	option	No		JSON attachments array

Examples

pega participants update MYAPP-CASE-1 --participant-id PEGA-PART-X --data '{"email":"a@b.com"}'