Update a customer
Updates the fields you send on one customer. The path customer_id selects the customer and replaces any customer_id in the body. Empty values change nothing, the customer type cannot change, and KYC status is not reset. The response does not include the customer. Get the customer to read the result.
Path Parameters
The customer to update. It replaces any customer_id in the body.
Request Body
Ignored. The path customer_id replaces any value you send.
Letters, spaces, apostrophes and hyphens only.
Letters, spaces, apostrophes and hyphens only.
New email. It must be unique in your tenant and use a company domain, for every customer type.
A valid phone number in international format with a leading +, such as +2348031234567. Fictional ranges such as +1 555-01xx are rejected.
Possible values: male, female, other
New address. The state and country check runs only when you send both.
Business customers only. Ignored for individuals. Send id to edit a person. Omit it to add a new person, who then needs first_name, last_name, email, gender, date_of_birth, phone and address.
ID of an existing associated person. Omit it to add a new person.
Letters, spaces, apostrophes and hyphens only.
Letters, spaces, apostrophes and hyphens only.
Possible values: male, female, other
A valid phone number in international format with a leading +, such as +2348031234567. Fictional ranges such as +1 555-01xx are rejected.
ISO 3166-2 code, such as NG-LA or US-FL. It must belong to country.
ISO 3166-1 alpha-2 code in upper case, such as NG.
Request Examples
{
"first_name": "Jane",
"last_name": "Smith",
"phone": "+2348031234568"
}
{
"business_name": "Acme Corp Ltd",
"business_description": "Enterprise software solutions",
"registration_number": "RC-111222",
"associated_persons": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"first_name": "Jane",
"last_name": "Doe"
}
]
}
Responses
| Status | Description |
|---|---|
200 |
Customer updated |
400 |
Invalid field, or the customer is not in your tenant |
200 response
{
"data": {
"message": "customer updated successfully",
"status": true
},
"error": null
}
400 response
{
"data": null,
"error": "failed to update customer: user not found"
}
{
"data": null,
"error": "associated person phone is required for new persons"
}
Authorization
- ApiKeyAuth