AFafriex
Customers

Create a new customer

Creates a new customer for a business. phone is validated against countryCode and stored in E.164 format. If you post the email of a customer that was previously deleted, that customer is reactivated (its stored countryCode is kept) and the call still returns 201.

post/api/v1/customer

Request

Request body

fullNamestring required

The full name of the customer. Must not be empty.

emailstring email required

The email address of the customer.

phonestring required

The phone number of the customer. It must be valid for countryCode; it is normalised to E.164 on save.

countryCodestring required

The ISO 3166-1 alpha-2 country code of the customer (e.g., 'NG', 'US'). Must be a supported country, otherwise the request fails with 400 INVALID_BUSINESS_CUSTOMER_REQUEST.

metaobject

Optional meta data you can attach to the customer.

Example request

{
  "fullName": "John Doe",
  "email": "john.doe@example.com",
  "phone": "+2348192837465",
  "countryCode": "NG"
}

Response

Customer created successfully. Returns the newly created customer object.

Changes

No recorded changes to this operation across all 1 revision of this API.