Update Customer

put

https://api.authvia.com/v3/accounts/{account-id}/customers/{ref}

🔑
scope customers:update

Update a specific Customer by their reference ID. This endpoint allows you to modify customer information including profile, addresses, and metadata.

📘
Info
The customer reference must exist within your account. This endpoint replaces all customer data with the provided information.
Use PATCH for partial updates if you only need to modify specific fields.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account-id

string

required

The unique identifier (AVID) of the Account.

ref

string

required

The Account's (Merchant's) unique reference identifier for the Customer.

Body Params

Paylaod for updating a customer.

metadata

object

Add additional information associated with the customer like name, location etc. A special mention to the customers/crm/authvia product which can enable a signup form for customers to self sign up and/or add validation checking for each customer created.

addresses

array of objects

length ≥ 1

Deprecated. Allow multiple addresses to be linked to the customer. However, the order of the addresses is important, as the first one is always selected as the default.

addresses

value

required

The address value must be a valid address-format: either in E.164 format for phone numbers or as a valid email address. This is necessary for customer login and receiving messages.

Value should be a valid email address.

appdata

object

A merchant can add extra details for a customer, such as notes, references, secret etc, which are not visible to the customer. This attribute is only deliviered on webhook payloads and returned for API calls to load a customer record.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Successfully updated customer. Returns the complete updated customer details.

400Bad Request - The request cannot be processed due to a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401The request is valid, but server authentication failed to verify the identity. The user's access token has either expired or is not valid. Creating a new token might resolve the issue.