Update primary contact

Update the primary contact for the given customerId.

🚧Warning

Use of this endpoint requires approval from Q2 and your bank of record.

Error Codes

Click to expand
CodeMessage (en-US)Notes
1-60000Any "Common Error Code" may occur.See Common Error Codes
60001{customerType} {customerId} is invalid.
60002{customerType} {customerId} is inactive.
60003{customerType} {customerId} is not in a {statusDescription} status.
60004{customerType} {customerId} is locked.
60005{customerType} {customerId} is marked as deceased.
156401Invalid relationship to edit. Relationship between PrimaryCustomerId {primaryCustomerId} and RelatedCustomerId {relatedCustomerId} doesn't exist.
156408Invalid relationship to edit. Relationship between PrimaryCustomerId {primaryCustomerId} and RequestingCustomerId {requestingCustomerId} doesn't exist.
196024PrimaryCustomerId is required.
196025RelatedCustomerId is required.
196026RequestingCustomerId is required.
196027externalAccountAccessType '{request.externalAccountAccessType}' is invalid. Please refer to API documentation for valid types.
Body Params
int32
required
≥ 1

The helix-assigned unique ID for the customer making the request

int32
required
≥ 1

The helix-assigned unique ID for the customer whose primary contact is being updated

int32
required
≥ 1

The helix-assigned unique ID for the customer who is to be the new primary contact for primaryCustomerId

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json