Skip to main content
PUT
Update Customer

Authorizations

Authorization
string
header
default:{{APIKey}}
required

Path Parameters

id
string
required

The _id of the customer you wish to update.

Body

application/json
type
enum<string>
default:individual
required

This is the customer type.

Available options:
individual,
company
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
phoneNumber
string

Customer's phone number: 7 to 15 digits, optionally starting with + and the country code (e.g. +2348031234567). Spaces, dashes and brackets are allowed. Required for USD cards. For USD cards, save it in international format, such as +2348031234567; a number without its country code is read as one from the billing country.

emailAddress
string

Customer's email address. Must be a valid email address. Required for USD cards.

individual
object

Individual details. Required if customer type is individual.

company
object

Company details. Required if customer type is company.

metadata
string<json>

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

billingAddress
object

This is the billing address of the customer.

Response

Customer updated successfully.

statusCode
integer

HTTP status code returned by the API.

message
string

Human-readable description of the result.

data
object

Response payload.