Update Customer details

patch

http://localhost:8080/v0/customers/{customerId}

Path Params

customerId

uuid

required

Unique identifier (UUID) of the Customer

Body Params

Describes the changes to be applied to Customer record. Only the provided information will be updated. Address and Phone Number will be replaced as a whole (no partial updates are possible).

address

object

Address of the Customer

dateOfBirth

date

Date of birth of the Customer in ISO format YYYY-MM-DD

documentData

object

Document data of the customer. When provided will be updated as a whole, setting the not provided fields to null.

string

Email address of the Customer

firstName

string

First name of the Customer

gender

string

Gender of the customer. Possible values:

MALE
FEMALE
OTHER

lastName

string

Last name of the Customer

middleName

string

Middle name(s) of the Customer

phoneNumber

object

Phone number of the Customer

preferredName

string

Preferred name of the Customer

skipPayIdUpdate

boolean

Defaults to false

Updating a customer's name will also update the payIDs of the linked accounts. If this flag is set to true, the payId update will be skipped.

taxObligations

array of objects

Captures any foreign (outside Australia) tax obligations for the Customer.

Notes:

Overrides existing list with a new provided
Setting to [] (empty array) deletes all existing items from the list

taxObligations

title

string

Title of the Customer

Responses

Language

Loading…

Response

Choose an example:

application/json

200Success

400Bad Request

403Forbidden

422Unprocessable Entity

500Internal Server Error

501Not Implemented