Prerequisites
Before using this endpoint, ensure you have:- An active Campaign for mobile data disbursement — available from the Campaigns page.
-
There are two ways to get CampaignId
- Go to the Campaigns page and copy the id by clicking the copy icon on the table as shown on the photo below.
-
- Call the List Campaigns endpoint to retrieve all available campaigns and their IDs.
- Go to the Campaigns page and copy the id by clicking the copy icon on the table as shown on the photo below.
- API Client Authorization — Ensure your API Client includes permission to perform mobile data disbursement. Permissions can be managed from the API Clients page.
Optional Delivery Tracking
You may include an optionalreceiptRequest object in the request body to receive webhook notifications when a disbursement attempt completes. This enables tracking of delivery outcomes per recipient.
The receiptRequest object includes:
- correlator — A unique client-defined identifier used to correlate the delivery receipt with the original request.
- callbackUrl — A publicly accessible URL where delivery receipts will be pushed.
Example Using curl
By using the Mobile Data Disbursement API, you can automate bandwidth provisioning workflows, enable bulk allocations, and maintain traceability through correlators and callback receipts—ensuring a reliable and auditable delivery process.
