Create address change

post

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

Creates a new address change record for a specific account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

acctid

string

required

The account identifier.

Body Params

The address change data to create.

Request body for creating a new address change record on an 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.

addressLineOne

string | null

Street address line 1.

addressLineTwo

string | null

Street address line 2 (apartment, suite, etc.).

city

string | null

City name.

stateCode

string | null

Two-letter US state code (e.g. MN).

postalCode

string | null

5-digit US postal code.

effectiveDate

string

required

length ≥ 1

Date the address change becomes effective. Required. Format: YYYY-MM-DD.

endDate

string

required

length ≥ 1

Date the address change record expires. Required. Format: YYYY-MM-DD.

addressType

string

required

length ≥ 1

Type of address (e.g. Home, Mailing). Required.

changeStatus

string

required

length ≥ 1

Processing status of the address change record (e.g. Pending, Applied). Required.

clientAddressId

string | null

Your system's identifier for this address change record.

clientAddressType

string | null

Your system's identifier for the address type.

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

201

Created

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

422Unprocessable Content