CustomersCreate Bulk Customer

Create Bulk Customer

This endpoint allows you to register multiple customers on the platform simultaneously by submitting an array of customer information. This is useful for onboarding multiple customers at once.

API Endpoint

POST https://backendapi.sayswitchgroup.com/api/v1/customer/bulk_create

Sample Request

curl -X POST https://backendapi.sayswitchgroup.com/api/v1/customer/bulk_create \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -d '{
    "customers": [
      {
        "email": "akinlabiolaoluwa15@gmail.com",
        "first_name": "olaoluwa",
        "last_name": "akinlabi",
        "phone": "07040237649",
        "bvn": "22358970815" // optional
      },
      {
        "email": "adola.bisi@gmail.com",
        "first_name": "Adeola",
        "last_name": "Bisi",
        "phone": "08039876543"
      }
    ]
  }

Request Explanation

FieldsTypeDescription
customersarrayAn array of customer objects to be created.
emailstringThe customer’s valid email address.
first_namestringThe customer’s given name.
last_namestringThe customer’s surname or family name.
phonestringThe customer’s primary phone number.
bvnstring(Optional) The customer’s Bank Verification Number.

Sample Response

{
  "status": true,
  "message": "Customers processed",
  "data": {
    "batchid": "0705855c54999",
    "totalSubmitted": 2,
    "totalCreated": 2,
    "totalSkipped": 0,
    "domain": "live"
  }
}

Response Explanation

FieldsTypeDescription
statusbooleanIndicates whether the request was successful.
messagestringA descriptive message about the operation result.
batchidstringUnique identifier for this bulk creation batch.
totalSubmittedintegerTotal number of customers submitted in the request.
totalCreatedintegerNumber of customers successfully created.
totalSkippedintegerNumber of customers skipped (e.g., duplicates).
domainstringThe domain environment (e.g., “live” or “test”).
Create CustomerGet Customers