Campaigns and Actions API
You build a data plan in the Aura dashboard: how much data customers get, how often, and the action that keeps it, such as a savings deposit of at least ₦5,000 each week. Your systems then tell Aura what each customer did. Aura checks the plan’s rules, delivers the data on the customer’s own network, and sends you a webhook for every moment of the plan, so you can message your customers in your own app.
How a plan works
Section titled “How a plan works”- The plan is offered. Either after the customer does the action that starts it, such as a first deposit, or by an offer you send to customers you pick. Each campaign uses one of the two.
- The customer accepts. On the plan card, inside your app, they accept the plan and choose which of their numbers gets the data. The first week’s data arrives straight away.
- They keep it by acting. Each week, the plan’s action keeps the plan and earns that week’s data.
- A nudge before the loss. If this week’s action isn’t in 48 hours before the week ends, Aura sends
plan.at_risk, so you can tell the customer the plan cancels unless they act. - A missed week cancels the plan. Aura sends
plan.cancelled, and the customer gets nothing the next week.
Weekly is the default. A plan can also deliver daily or monthly, and then each step above happens per day or per month. The detail is in How a plan runs.
| What | How it is written | Example |
|---|---|---|
| Data | Gigabytes (GB) of mobile data, as a number. | "amount_gb": 1.5 is 1.5GB. |
| Money | Naira, as a whole number of kobo (₦1 is 100 kobo), with the currency NGN. |
{ "amount": 100000, "currency": "NGN" } is ₦1,000. |
| Time | ISO 8601. Aura returns UTC. Days and weeks are counted in Lagos time, and weeks run Monday to Sunday. | 2026-10-25T22:59:59Z is 11:59:59pm on Sunday 25 October in Lagos. |
The CSV upload is the one place money is written in naira rather than kobo: its amount_naira
column takes 25000 for ₦25,000.
You set and see data in gigabytes, such as 1.5GB a week, and the naira price charged for each delivery. You never choose network bundles: Aura delivers the amount you set on each customer’s network.
What happens where
Section titled “What happens where”| In the dashboard | Through the API or a CSV upload |
|---|---|
| Build and change campaigns: the actions, the data, the nudge, limits, budget and comparison group. | Read your campaigns and the key of each action. |
| Create and revoke API keys, and add webhook endpoints. | Report what customers did, and send offers. |
| Review flagged rewards. | Get each customer’s plan, and open the plan card for them. |
| Send test events and move test plans forward. | Accept a plan and change its number, if you build your own plan screen. |
| See your results. | Follow each reward, and read your balance and statements. |
Campaigns are built and changed only in the dashboard. The API reads them, so one place holds the plan’s design.
The endpoints
Section titled “The endpoints”| Endpoint | What it does |
|---|---|
GET /campaigns, GET /campaigns/{campaign_id} |
Read the plans built in the dashboard, with each action’s key and readable name. |
POST /actions |
Report what a customer did. The answer says at once whether it earned data, and why not. |
POST /offers |
Offer a plan to a customer, for campaigns that start plans by offer. |
GET /actions, GET /actions/{action_id} |
Look actions up, including by your own reference. |
GET /customers/{customer_id}/plan |
Where one customer stands: this week’s data, what keeps it, when the week ends. |
POST /customers/{customer_id}/plan-card-links |
A signed link that opens the plan card in your app. |
POST /customers/{customer_id}/plan/accept |
Accept a plan from your own screens. |
POST /customers/{customer_id}/plan/phone-number |
Change the number that gets the data, at most once a month. |
GET /rewards, GET /rewards/{reward_id} |
Each delivery of data, from earned to confirmed. |
POST /sandbox/plans/{plan_id}/advance |
Sandbox only: move a test plan to its warning or its week’s end. |
GET /balance, statements |
Your balance and daily statements, the same endpoints as the Data Reselling API. |
The addresses, keys, error shape, request IDs, rate-limit headers and pagination are the same as the Data Reselling API. You don’t need the Data Reselling API to run campaigns.
The comparison group
Section titled “The comparison group”A campaign can hold back a share of new customers, up to half, who aren’t offered the plan, so your results show
what the plan caused. Aura places each customer at random the first time you report them, by an action or an offer,
and every action and offer returns the customer’s group.
Don’t show the plan to customers in the comparison group, but keep sending their actions: they are what the plan
is measured against.
Rules Aura applies for you
Section titled “Rules Aura applies for you”- One reward per phone number. By default a phone number earns each reward once a period, whatever customer ID it arrives with. You can switch on stacking for your account or for one campaign, with a cap per number.
- Limits and budget. Limits per customer and per day, and a total budget in naira. The campaign pauses itself when it reaches its budget, and on its end date.
- Bonus-hunter checks. A reward can wait for your review before it is delivered. See Flagged rewards.
- A safe price. Each delivery’s price is held from your balance and charged only when the network confirms the data arrived.
© 2026 PressOne Africa Limited ·poweredbyaura.com ·Privacy ·Terms