PUT
/
customers
/
{id}

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

The _id of the customer you wish to update.

Body

application/json
name
string
required

The customer's full name.

status
enum<string>
default:
active
required

This is the status of the customer.

Available options:
active,
inactive
type
enum<string>
default:
individual
required

This is the customer type.

Available options:
individual,
company
billingAddress
object

This is the billing address of the customer.

company
object

Company details. Required if customer type is company.

emailAddress
string

Customer's email address.

individual
object

Individual details. Required if customer type is individual.

metadata
string

The customer metadata object in key-value pair. This can be useful for storing additional information about the customer in a structured format

phoneNumber
string

Customer's mobile phone number in international format.

Response

200 - application/json

The response is of type object.