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": "SendToEach",
  "disbursements": [
    {
      "phone": "<string>",
      "denomination": "10MB",
      "message": "<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 the reward.mobile-data.disburse API client authorization scope to disburse mobile data. You can set up scopes on the API Clients page.

​
Rate Limit

This endpoint is rate limited to 400 disbursements per second.

​
Request Modes

The API supports two request modes:
  • SendToMany — same data amount (and optional SMS message) sent to multiple recipients
  • SendToEach — individual data amounts and optional messages per recipient
Both modes support a maximum of 100 recipients per request and the optional message is limited to not more than 960 characters .

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 a custom denomination to each recipient

​
type
enum<string>
required

Indicates per-recipient bundle disbursement mode

Available options:
SendToEach
​
disbursements
object[]
required

List of recipients with individual denominations

Required array length: 1 - 100 elements
​
messaging
object

Messaging configuration used when sending optional SMS notifications.

​
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