Update Contact

post

https://sandbox-api.prioritycommerce.com/v1/passport/v1/customer/{parentIdType}/{customerId}/contact/{idType}/{id}

Update an existing contact. Supports modifying payee details, bank accounts, cards, and addresses.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

parentIdType

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:

customerId

string

required

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

idType

string

enum

required

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

Allowed:

string

required

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

Body Params

Details required to update contacts.

name

string

Display label of contact.

contactType

string

enum

Type of Customer.

Allowed:

firstName

string

First name of contact of type INDIVIDUAL.

lastName

string

Last name of contact of type INDIVIDUAL.

legalName

string

Legal name of contact of type BUSINESS.

ppi

string

Add PPI (Passport Payment ID) as contact.

card

object

Save contact’s card details within the system.

externalAccount

array of objects

Details of external account being added as contact.

externalAccount

internationalExternalAccount

array of objects

Conditional, can be updated until the international external account (with USD currency) is in “INACTIVE” or “PENDING_VERIFICATION” status.

internationalExternalAccount

mailingAddress

array of objects

Details of mailing address being added as contact.

mailingAddress

Headers

PromiseMode

string

enum

required

This is a mandatory field, user must provide input either 'ALWAYS' or 'NEVER'. 'NEVER' - For immediate response, 'ALWAYS' - For later response.

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.

Language

Credentials

Header

Loading…

Response

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

application/json

204The operation was completed successfully. No content returned.