Update a customer beneficiary

post

https://sandbox-api.helix.q2.com/customerBeneficiary/update

See customerBeneficiary object definition for parameter details.

Error Codes

Click to expand

Code	Message (en-US)	Notes
1-60000	Any "Common Error Code" may occur.	See Common Error Codes
60114	emailAddress is not valid	Email address is not properly formatted
61400	Program is not authorized to use this endpoint. Please contact your relationship manager for details.
66601	Invalid customer beneficiary id '0.'
66602	Tax ID must be 9 digits.
66603	Birth date must be in the past.
66604	If Legal name 2 is used, Legal name 1 is required.

Body Params

customerId

int32

required

≥ 1

customerBeneficiaryId

int32

required

≥ 1

firstName

string

length ≤ 50

middleName

string

length ≤ 50

lastName

string

length ≤ 50

birthDate

date-time

taxId

string

length ≤ 30

No formatting (no dashes, spaces, etc).

addressLine1

string

length ≤ 100

addressLine2

string

length ≤ 100

addressLine3

string

length ≤ 100

addressLine4

string

length ≤ 100

city

string

length ≤ 50

state

string

length ≤ 2

postalCode

string

length ≤ 9

country

string

length ≤ 50

legalName1

string

length ≤ 100

legalName2

string

length ≤ 100

distributionDescription

string

length ≤ 50

emailAddress

string

length ≤ 256

phoneNumber

string

length ≤ 15

beneficiaryType

string | null

enum

The type of beneficiary. Accepted values: Individual, Trust, Estate, Charity, NonProfit, Other

Allowed:

taxIdType

string

enum

Allowed:

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

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

application/json

Error Codes

200An envelope whose data node is a customerBeneficiary object

400Bad Request

401Unauthorized

404Not Found

405HTTP Method Not Allowed

429Rate Limit Exceeded