Update Group

put

https://s3partnerapi-staging.solutran.com/2.2/groups/{id}

Updates an existing group.
The ID parameter handling depends on the ID-Type header: if set to 'Client', the ID is treated as a ClientAccountId; otherwise, it's treated as a server/internal ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The group identifier.

Body Params

The group update model.

Request body for updating an existing group.

clientRequestId

string | null

Optional caller-supplied correlation ID. Returned in response headers and logs for end-to-end tracing.

updatedUser

string | null

Username or system identifier of the user performing the update. Used for audit trail.

int64

S3 internal group identifier. Must match the {id} path parameter.

programId

int64

S3 internal program identifier the group belongs to.

clientGroupId

string

required

length between 1 and 50

Your system's unique identifier for this group. Required. Max 50 characters.

name

string

required

length between 1 and 255

Display name of the group. Required. Max 255 characters.

userDefined1

string | null

Client-defined custom field 1. Max 255 characters.

userDefined2

string | null

Client-defined custom field 2. Max 255 characters.

userDefined3

string | null

Client-defined custom field 3. Max 255 characters.

currentState

object

A group organizes accounts within a program. Groups can contain subgroups.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

204

No Content

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK

422Unprocessable Content