Update Account

put

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

Updates an existing account.
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 account identifier.

Body Params

The updated account information.

Request body for updating an existing household 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.

int64

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

clientAccountId

string | null

Your system's identifier for this account. Max 100 characters.

programId

string | null

The program identifier.

subgroup

object

Subgroup reassignment fields for an account update.

dateOfBirth

string | null

Member date of birth. Format: YYYY-MM-DD.

string | null

Member email address. Max 50 characters.

firstName

string | null

Member first name. Max 50 characters.

lastName

string | null

Member last name. Max 50 characters.

middleInitial

string | null

Member middle initial. Max 1 character.

languageCode

string | null

IETF language tag (e.g. en-US). Max 5 characters.

phone

string | null

^$?([0-9]{3})$?[-. ]?([0-9]{3})[-. ]?([0-9]{4})$

Primary phone number. Format: ###-###-#### or (###) ###-####.

secondaryPhone

string | null

^$?([0-9]{3})$?[-. ]?([0-9]{3})[-. ]?([0-9]{4})$

Secondary / alternate phone number. Same format rules as Phone.

userDefined1

string | null

Client-defined custom field 1. Max 50 characters.

userDefined2

string | null

Client-defined custom field 2. Max 50 characters.

userDefined3

string | null

Client-defined custom field 3. Max 50 characters.

userDefined4

string | null

Client-defined custom field 4. Max 50 characters.

alternateSearchKey

string | null

An additional key used to look up the account from an external system. Max 50 characters.

healthySavingsEligible

string | null

Whether the member is eligible for Healthy Savings. Accepted values: Yes, No.

crosswalkKey

string | null

Crosswalk identifier. Changing this value triggers a void-and-reissue of any crosswalk-linked benefits.

address

object

Updated mailing address for an account.

startDate

date-time

Account effective start date. Must be before EndDate.

endDate

date-time

Account expiry date. Must be after StartDate.

status

string | null

Account status. Accepted values: Active, Inactive.
Use /deactivate or /reactivate to change status via dedicated workflows.

createEligibilityRecord

boolean

When true, an eligibility record is created alongside the update.

memberships

array of objects | null

Membership records to sync. The supplied list replaces the existing memberships.

memberships

deactivateRequest

boolean

Read-only. Set internally before validation to enable status-transition rules.

currentState

object

Household account resource. The central entity of the S3 platform.
May be expanded to include Benefits, Transactions, Cards, and Memberships.

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

200OK

400Bad Request

401Unauthorized

403Forbidden

422Unprocessable Content