Update an existing authorized user

post

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

Modify the details of an authorized user, including personal information, contact details, and citizenship status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

parentIdType

string

enum

required

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

Allowed:

customerId

string

required

The identifier value corresponding to the selected identifier type.

idType

string

enum

required

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

Allowed:

string

required

The identifier value corresponding to the selected identifier type.

Body Params

Fields to update on the authorized user record.

externalId

string

Reference id assigned by the program manager.

firstName

string

First name of authorized user.

middleName

string

Middle name of authorized user.

lastName

string

Last name of authorized user.

ssn

string

Social security number of authorized user.

mobilePhone

string

Mobile number of authorized user.

mailingAddress

array of objects

The individual’s mailing address. Individual can have one or multiple mailing addresses.

mailingAddress

isUSCitizen

boolean

Authorized user is a US citizen or not.

string

Email of authorized user.

Headers

PromiseMode

string

enum

required

Required. Set to NEVER for a synchronous response or ALWAYS for asynchronous processing.

Allowed:

Responses

202

The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs. Expected for all requests with Promise Mode as ALWAYS.

204

The Passport server successfully processed the request and is not returning any content. This is expected for all updates, deletion requests on the resources.

299

The Passport server successfully processed the request i.e. the object has been created or modified as requested, however the action may have an impact on transacting which is notified in the warning.

400

The request could not be accepted by the Passport server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

Language

Credentials

Header

Loading…

Response

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

application/json

200The Passport server successfully processed the request.