Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Stakeholder User management

Update stakeholder group

Update a stakeholder group for stakeholder communications.

post/stakeholder-comms/cloudId/{cloudId}/api/stakeholder_groups/{groupId}/update

Path parameters

groupIdstring required

Identifier of the stakeholder group.

Request body

namestring

Name of the stakeholder group.

descriptionstring

Description of the stakeholder group.

ownerIdstring

Identifier of the group owner.

logoUrlstring

URL of the group logo.

status'ACTIVE' | 'INACTIVE' | 'SUSPENDED' | 'DELETED'

Status of the stakeholder group.

insertedAtstring date-time

When the group was created.

updatedAtstring date-time

When the group was last updated.

servicesstring[]

Service identifiers associated with the group.

Response

Returned if the stakeholder group is successfully updated.

errorstring

Error message, if the operation was not successful.