v1

latestOpenAPI 3.1.02026-07-2469193340.0 KB
Contacts

Update a Contact

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

<aside class="notice"> <ul> <li>Previous transactions to this Contact will retain the name and bank account that was used at the time.</li> <li>You cannot update a Contact's bank account details if they currently have an accepted agreement.</li> <li>Any active Bank Connections will be lost if you change the Contact's bank account.</li> <li>See our <a href="https://help.zepto.money/en/articles/3829211-how-do-i-change-my-customers-bank-account-details">Help Article</a> for more information about the nuances and implications of changing a contacts Bank Account.</li> </ul> </aside>
patch/contacts/{id}

Path parameters

idstring required

Contact ID (Contact.data.id)

Request body

namestring

The name of the Contact

emailstring

The email of the Contact

branch_codestring

The bank account BSB of the Contact

account_numberstring

The bank account number of the Contact

metadataMetadata

Use for your custom data and certain Zepto customisations.

Example request

{
  "name": "My very own alias",
  "email": "updated@email.com",
  "branch_code": "123456",
  "account_number": "99887766",
  "metadata": {
    "custom_key": "Custom string",
    "another_custom_key": "Maybe a URL"
  }
}

Response

OK

dataobject required

Example response

{
  "data": {
    "id": "fcabeacb-2ef6-4b27-ba19-4f6fa0d57dcb",
    "name": "My very own alias",
    "email": "updated@email.com",
    "type": "anyone",
    "metadata": {
      "custom_key": "Custom string",
      "another_custom_key": "Maybe a URL"
    },
    "bank_account": {
      "id": "55afddde-4296-4daf-8e49-7ba481ef9608",
      "account_number": "99887766",
      "branch_code": "123456",
      "bank_name": "Zepto SANDBOX Bank",
      "state": "active",
      "iav_provider": null,
      "iav_status": null,
      "blocks": {
        "debits_blocked": false,
        "credits_blocked": false
      }
    },
    "anyone_account": {
      "id": "63232c0a-a783-4ae9-ae73-f0974fe1e345"
    },
    "links": {
      "add_bank_connection": "https://go.sandbox.zeptopayments.com/invite_contact/dog-bones-inc/fcabeacb-2ef6-4b27-ba19-4f6fa0d57dcb"
    }
  }
}