unPLUGDevelopers
/

Management API

Endpoints that do what the unPLUG Dashboard does, for brands that want their own tools to do it: create and run offers and challenges, adjust points, merge members and read reports.

You probably don't need this. To run loyalty in your app or website, everything is in the App API. Your team creates offers and challenges in the unPLUG Dashboard, and your app shows them and lets guests use them.

Productionhttps://api.unplugdining.com/v1uk_live_ keys
Sandboxhttps://sandbox.api.unplugdining.com/v1uk_test_ keys
CredentialSecret keyServer side only, never a member token

How it differs from the App API#

  • Server only. Every endpoint takes a secret key. A member token can't call any of them.
  • Its own scopes. offers:write, challenges:write, points:adjust and reports:read. Ask support for a separate key for the tool that uses them, so your app backend never holds them.
  • Its own contract. The OpenAPI file is openapi-management.yaml, separate from the App API's openapi.yaml.
  • Same rules. Errors, idempotency, pagination, rate limits and versioning work the same way.

26 endpoints: 1 available at launch, 25 coming soon.

Guides#

How to run offers from your own tools.

Run offers from your serverCreate, publish, preview and grant offers, print unique code batches and set budgets from your own tools instead of the unPLUG Dashboard.

Offers#

Create, publish, preview and grant offers, and print unique code batches.

Offers
POST/v1/offersCreate an offerSoonGET/v1/offersList offersSoonGET/v1/offers/{id}Get an offerSoonPATCH/v1/offers/{id}Update an offerSoonPOST/v1/offers/{id}/publishPublish an offerSoonPOST/v1/offers/{id}/pausePause an offerSoonPOST/v1/offers/{id}/resumeResume an offerSoonPOST/v1/offers/{id}/endEnd an offerSoonPOST/v1/offers/{id}/previewPreview an offerSoonPOST/v1/offers/{id}/grantsGrant an offerSoonPOST/v1/offers/{id}/code_batchesCreate a code batchSoonGET/v1/offers/{id}/code_batches/{batch_id}/codesList codes in a batchSoonPOST/v1/offers/{id}/code_batches/{batch_id}/voidVoid a code batchSoon

Challenges#

Create, publish and run challenges, enroll members by hand and list templates.

Challenges
GET/v1/challengesList challengesSoonPOST/v1/challengesCreate a challengeSoonPATCH/v1/challenges/{id}Update a challengeSoonPOST/v1/challenges/{id}/publishPublish a challengeSoonPOST/v1/challenges/{id}/pausePause a challengeSoonPOST/v1/challenges/{id}/endEnd a challengeSoonPOST/v1/challenges/{id}/previewPreview a challengeSoonPOST/v1/challenges/{id}/enrollmentsEnroll membersSoonGET/v1/challenge_templatesList challenge templatesSoon

Member support#

Add or remove points by hand and merge duplicate members.

Points and member support
POST/v1/members/{id}/points_adjustmentsCreate a points adjustmentPOST/v1/members/{id}/mergeMerge membersSoon

Reports#

Program and reward totals by local day.

Reports
GET/v1/reports/program_summaryProgram summarySoonGET/v1/reports/rewardsRewards reportSoon