Using the dashboard
The API dashboard is where you get credentials, set up Services, watch requests and check your limits. Sign in with your business account.
The pages
| Page | What it is for |
|---|---|
| Get started | The plans while the API is off. Once it is on: four steps that tick off by themselves, and your first two calls filled in with your own Account SID and Service. |
| Campaigns and Rewards | Make the campaigns your links give rewards from, and start them. |
| Services | One per integration. Pick which campaigns it may use, how long links last, IP allowlists, CRM ingest and webhooks. |
| API keys | Your Auth Token and API keys. Give a key only the scopes it needs, limit it to some Services, set an expiry, and revoke it at any time. |
| Link sets | Every set made through the API: how many links, how many handed out, opened and redeemed. Download a set as a CSV. |
| Request logs | The last requests with status, error code, time taken and request id. Open one to see why it failed. |
| Usage | Requests, links made and errors per day, by key and by Service. |
| Plan and limits | Your plan, each limit with how much you use, the price to buy a link and how many links you have left. |
| Plan | Buy or renew the Business plan, or see Enterprise. |
| Buy links | Buy links in packs or any number, see how many are left, and every purchase, use and return. |
Your first hour
- Make a campaign under Campaigns, with its rewards, and start it. Links always come from a campaign.
- Copy your Account SID and create the Auth Token under API keys. For a server, create an API key instead and keep its secret: it is shown once.
- Create a Service and allow it to use your campaign.
- Make a set with
POST /v1/Services/{ServiceSid}/Sets. Check Link sets to see it. - Hand out a link with
Allocateand open the URL on your phone. Request logs shows the call. - Redeem it with the Scanner app or
Codes/{Code}/Redeem, then add a webhook so your system hears about the next one.
When a call fails
Every error response has an HTTP status, a numeric code, a plain message and a more_info link. Find the request in Request logs by its X-Request-Id. The most common ones:
| You see | Usually means | Fix |
|---|---|---|
401 | Wrong Account SID, token or key secret | Copy them again from API keys |
402 | No API access, plan ended, or no links left | Check Plan and limits; renew, or buy links |
403 | Key missing a scope, Service not allowed that campaign, or a plan limit | Edit the key or Service, or upgrade |
429 | Too many requests | Wait for Retry-After and try again |