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

/campaigns/{campaignId}/subscriptions

Authorizations

oAuthtokenIdHeader

Path parameters

campaignIdstringrequired

Body

userany ofrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://localhost:8080/v1/campaigns/{campaignId}/subscriptions' \
  --header 'Content-Type: application/json' \
  --data '{
    "user": {
      "email": "[e-mail]"
    }
  }'

200

400

200

{
  "subscriptionId": "text"
}

accepted

Retrieve subscription

Get subscription state for a user, including incentives completion

get

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

Authorizations

oAuthtokenIdHeader

Path parameters

userIdstringrequired

Query parameters

identifierTypestring · enumrequired

Options: email, address, id

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://localhost:8080/v1/campaigns/{campaignId}/subscriptions/{userId}?identifierType=email'

200

200

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

Ok