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

PageWhat it is for
Get startedThe 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 RewardsMake the campaigns your links give rewards from, and start them.
ServicesOne per integration. Pick which campaigns it may use, how long links last, IP allowlists, CRM ingest and webhooks.
API keysYour 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 setsEvery set made through the API: how many links, how many handed out, opened and redeemed. Download a set as a CSV.
Request logsThe last requests with status, error code, time taken and request id. Open one to see why it failed.
UsageRequests, links made and errors per day, by key and by Service.
Plan and limitsYour plan, each limit with how much you use, the price to buy a link and how many links you have left.
PlanBuy or renew the Business plan, or see Enterprise.
Buy linksBuy links in packs or any number, see how many are left, and every purchase, use and return.

Your first hour

  1. Make a campaign under Campaigns, with its rewards, and start it. Links always come from a campaign.
  2. 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.
  3. Create a Service and allow it to use your campaign.
  4. Make a set with POST /v1/Services/{ServiceSid}/Sets. Check Link sets to see it.
  5. Hand out a link with Allocate and open the URL on your phone. Request logs shows the call.
  6. 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 seeUsually meansFix
401Wrong Account SID, token or key secretCopy them again from API keys
402No API access, plan ended, or no links leftCheck Plan and limits; renew, or buy links
403Key missing a scope, Service not allowed that campaign, or a plan limitEdit the key or Service, or upgrade
429Too many requestsWait for Retry-After and try again