Replace Client AccountId

post

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

Replaces the ClientAccountId (subscriber ID) for an active account.
Validates the request and ensures the new subscriber ID does not already exist in the system.
If ValidateOnly is false, performs the update; otherwise, only validates the request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The account identifier (client or server ID).

Body Params

The model containing the current and new subscriber IDs and validation flag.

Request body for replacing the ClientAccountId (subscriber ID) on an active account.

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.

clientAccountId

string

required

length between 1 and 100

The account's current ClientAccountId. Used to verify the correct account is being updated. Required. Max 100 characters.

int64

S3 internal account identifier. Populated from the {id} path parameter — do not set manually.

programId

string | null

The program identifier.

validateOnly

boolean

When true (default), the request is validated but no changes are committed.
Set to false to apply the update.

reasonCode

string

enum

required

Reason code for the subscriber ID change. Required.

Allowed:

newSubscriberId

string

required

length ≥ 1

The new ClientAccountId to assign to the account. Must not already exist in the program. Required.

Headers

string

enum

Defaults to application/problem+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

202

Accepted

204

No Content

Language

Credentials

Loading…

Response

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

application/problem+json

text/plain

application/json

text/json

400Bad Request

401Unauthorized

403Forbidden

422Unprocessable Content