API Reference
  1. Treasury Solutions
  2. Mailing Address

Update Mailing Address

post
https://sandbox-api.prioritycommerce.com/v1/passport/v1/customer///mailingAddress//

Update editable fields of an existing mailing address.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Identifier type for the customer. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:
string
required

Unique identifier of the customer. The value corresponds to the identifier type specified in parentIdType.

string
enum
required

Identifier type for the mailing address. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:
string
required

Unique identifier of the mailing address. The value corresponds to the identifier type specified in idType.

Body Params

Details required to update a mailing address.

string

Reference id to be assigned to the mailing address.

string

Address line to provide details. Range of characters: 4 to 40.

string

Address line to provide details. Max characters: 30.

string

Max characters: 45.Character allowed - a-z A-Z - .' \ sáéíóúüñÑÃÍÖŠšéÂïö.

string
enum

Should be two characters.

string

Should be numeric and can either be 5 or 9 digits.

boolean

Set mailing address as Primary Address. Only one primary address can be linked to a customer.

string

Should be numeric.

string

Name to which check needs to be delivered.

usage
object
Headers
string
enum
required

Controls response timing. NEVER returns an immediate response; ALWAYS defers processing and returns a 202 Accepted while the operation completes asynchronously.

Allowed:
Responses
202

The request has been accepted for processing. Expected when PromiseMode is ALWAYS.

299

The operation completed successfully, but the action may impact transacting. Check the warning details.

400

The request could not be processed due to invalid or missing parameters.

401

Authentication failed. Verify that the Authorization header contains a valid Bearer token.

403

The authenticated user does not have permission to perform this operation.

500

An unexpected error occurred on the Passport server while processing the request.

Updated 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?