Skip to main content

Overview

The customer update endpoint allows you to modify existing customer information. You can perform both partial and full updates to customer records.

Base URL

Authentication

All requests must include your API key in the Authorization header:

Request Parameters

Path Parameters

string
required
The unique identifier of the customer to update

Body Parameters

string
Customer’s first name
string
Customer’s last name
string
Customer’s email address. Must be a valid email format.
string
Customer’s phone number in E.164 format (e.g., +2348012345678)
object
Customer’s billing address information

Examples

Response

Success Response (200 OK)

Error Responses

Update Rules

Important Update Considerations

  • Only provide fields that need to be updated
  • Nested objects (like billing_address) must be updated as a complete object
  • Empty strings ("") will clear the field value
  • Null values are ignored
  • Phone numbers must be in E.164 format
  • Email addresses must be valid format

Rate Limits

Customer update requests are limited to:
  • 10 requests per minute per API key
  • 1000 requests per day per API key

Versioning

The current version of this API is v1. We recommend including a version accept header:

Best Practices

  1. Partial Updates
    • Only send fields that need to be changed
    • Use PATCH for partial updates
    • Validate data before sending
  2. Error Handling
    • Implement proper error handling
    • Validate response status codes
    • Log failed update attempts
  3. Idempotency
    • Use idempotency keys for critical updates
    • Retry failed requests with the same idempotency key
  4. Validation
    • Validate all input fields client-side
    • Handle validation errors appropriately
    • Check response data matches expected format

Need Help?

For additional support: