Update a Contact

You can update the name, email, bank account and metadata of any Contact.

  • Previous transactions to this Contact will retain the name and bank account that was used at the time.
  • You cannot update a Contact's bank account details if they currently have an accepted agreement.
  • Any active Bank Connections will be lost if you change the Contact's bank account.
  • See our Help Article for more information about the nuances and implications of changing a contacts Bank Account.
Path Params
string
required

Contact ID (Contact.data.id)

Body Params
string
length ≤ 140

The name of the Contact

string

The email of the Contact

string

The bank account BSB of the Contact

string

The bank account number of the Contact

string
Headers
string
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses

404

Not Found

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