Skip to main content
POST
/
data
/
{campaignId}
cURL
curl --request POST \
  --url https://api.belio.co.ke/data/{campaignId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "SendToMany",
  "phones": [
    "<string>"
  ],
  "denomination": "<string>"
}
'
{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "units": {
    "Safaricom": {},
    "Airtel": {}
  },
  "addresses": {
    "Safaricom": 123,
    "Airtel": 123
  }
}
Refer to Authentication for information on how to obtain a Bearer token.
This endpoint requires appropriate API authorization to perform mobile data disbursement. You can set up scopes on the API Clients page.

​
Rate Limit

This endpoint is rate limited to 400 disbursements per second.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
campaignId
string
required

Unique identifier that references the rules for the disbursement.

Body

application/json

Disbursement request payload

Send the same denomination to multiple recipients

​
type
enum<string>
required

Indicates bulk disbursement mode

Available options:
SendToMany
​
phones
string[]
required

List of recipients' phone numbers e.g [712345678, 11234567, 712345678]. Cannot be empty

Minimum array length: 1

Recipient phone number

​
denomination
string
required

Bundle to be sent to recipient (example: '500MB', '2GB'). The bundle denominations should exist in the chosen campaign

Minimum string length: 1
​
receiptRequest
object

Receipt callback configuration

Response

Request successfully queued for processing

​
requestId
string<uuid>

Unique identifier assigned to the request

​
units
object

Number of credit units consumed by the request, grouped by channel and denomination

​
addresses
object

Number of recipient addresses processed