Create Group

post

https://s3partnerapi-staging.solutran.com/2.2/groups

Creates a new group.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The group to create.

Request body for creating a new group within a program.

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. Populated on response; ignored on POST.

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.

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

201Created

422Unprocessable Content