Update a group

Update a group

put

Update an existing group

Authorizations
AuthorizationstringRequired

Use Common JWT

Path parameters
groupIdstringRequired

Group id

Example: 60af77fd294165466ccdf510
Header parameters
X-Symphony-Hoststring · min: 1Required

headers to indentify the originator

Example: localhost.symphony.com
If-MatchstringRequired

ETag of group to be updated

Example: e3a52e72-0854-4401-8c24-e0b17c0ca304
Body

A reduced set Group object, for retrieving list of group purpose

typestring · min: 1Required

Group type identifier

Example: SDL
ownerTypestring · enumRequired

Owner type. Ony TENANT supported now

Example: TENANTPossible values:
ownerIdinteger · int64Required

Owner id if the owner type is tenant (podId) or user (userId), otherwise null

Example: 100
namestring · min: 1Required

Group's name

Example: Test Group
subTypestring · enumOptional

The type of the company new groupType

Example: COMMUNITYPossible values:
referrerstringOptional

Symphony, referring company name, referring channel partner name

idstring · min: 1Optional

Group's unique identifier

Example: 60af77fd294165466ccdf510
statusstring · enumOptional

Status flag to distinguish between active and deleted objects

Example: ACTIVEPossible values:
eTagstring · min: 1OptionalExample: e3a52e72-0854-4401-8c24-e0b17c0ca304
Responses
chevron-right
200

Successful response. Returns the group just updated

application/json
put
/v1/groups/{groupId}

Last updated

Was this helpful?