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

POSThttp://localhost:8080/v1/campaigns/{campaignId}/subscriptions

Path parameters

campaignId*string

Body

application/json

user*UserIdentifierDto (any of)

UserWithEmailDto (object)UserWithEthAddressDto (object)UserWithIdDto (object)

Response

200400

accepted

Body

application/json

subscriptionIdstring

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/v1/campaigns/{campaignId}/subscriptions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "user": {}
    }),
});
const data = await response.json();

Response

200400

{
  "subscriptionId": "text"
}

Retrieve subscription

Get subscription state for a user, including incentives completion

GEThttp://localhost:8080/v1/campaigns/{campaignId}/subscriptions/{userId}

Path parameters

userId*string

Query parameters

Response

200

Ok

Body

application/json

createdAtstring (date)

incentivesarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/v1/campaigns/{campaignId}/subscriptions/{userId}?identifierType=email', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "createdAt": "2024-10-12",
  "incentives": [
    {
      "id": "text",
      "status": "VERIFIED",
      "reward": 0,
      "createdAt": "2024-10-12"
    }
  ]
}