PassKit Coupons API Documentation

This is the complete API documentation for connecting to the PassKit Coupons API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet PassKit Coupons: PassKit Coupons lets teams create and manage PassKit single-use coupon campaigns, offers, coupons, and coupon analytics through PassKit's coupon APIs. Keep reading to get started.

Quickstart

Before you run your first PassKit Coupons request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one PassKit Coupons connection — create or choose one in Connections. Note its connectionId.

Every PassKit Coupons action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/passKitCoupons/latest/actions/{actionSlug}

You need a MindCloud API Key and a PassKit Coupons connection. Then call an action such as Count Coupons:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/passKitCoupons/latest/actions/count-coupons" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected PassKit Coupons account that should run the action. MindCloud stores and refreshes the PassKit Coupons credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

PassKit Coupons actions

All 25 published actions for this PassKit Coupons version. Each page documents the endpoint, arguments, and response controls.

• DELETEBulk Void Coupons
• POSTCopy Campaign
• GETCount Coupons
• POSTCreate Coupon
• POSTCreate Coupon Campaign
• POSTCreate Coupon Offer
• DELETEDelete Coupon Campaign
• DELETEDelete Coupon Offer
• GETGet Coupon by External ID
• GETGet Coupon by ID
• GETGet Coupon Campaign
• GETGet Coupon Campaign Analytics
• GETGet Coupon Offer
• GETGet Meta Keys for a Campaign
• GETGet User Profile
• GETList Coupon Campaigns
• GETList Coupon Offers
• GETList Coupons
• PUTRedeem Coupon
• PUTUpdate Coupon
• PUTUpdate Coupon Campaign
• PUTUpdate Coupon External Id
• PUTUpdate Coupon Offer
• PUTUpdate Personal Information
• DELETEVoid Coupon

Related apps

More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.

Google FormsMailchimpCalendlyWebflowGoogle AdsActiveCampaignBrevoMailerLite