Subscriptions

To keep track of users' participation within various campaigns, we use subscriptions. Before a user can participate in a campaign, they must first subscribe to the campaign.

The subscription object

This object represents the subscription of a user to a campaign.

Create subscription

Create a new subscription for the given user

post

Authorizations

oAuthtokenIdHeader

OAuth2clientCredentialsRequired

Token URL:

Path parameters

campaignIdstringRequired

Body

application/json

userany ofRequired

or

or

Responses

200

accepted

application/json

400

missing required parameters

application/json

post

/campaigns/{campaignId}/subscriptions

HTTPcURLJavaScriptPython

POST /v1/campaigns/{campaignId}/subscriptions HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "user": {
    "email": "[e-mail]"
  }
}

{
  "subscriptionId": "text"
}

Retrieve subscription

get

Get subscription state for a user, including incentives completion

Authorizations

oAuthtokenIdHeader

OAuth2clientCredentialsRequired

Token URL:

Path parameters

userIdstringRequired

Query parameters

identifierTypestring · enumRequiredPossible values:

Responses

200

Ok

application/json

get

/campaigns/{campaignId}/subscriptions/{userId}

HTTPcURLJavaScriptPython

GET /v1/campaigns/{campaignId}/subscriptions/{userId}?identifierType=email HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Ok

{
  "createdAt": "2025-12-08",
  "incentives": [
    {
      "id": "text",
      "status": "VERIFIED",
      "reward": 1,
      "createdAt": "2025-12-08"
    }
  ]
}