Activate challenge

curl --request PUT \
  --url https://{host}/challenge/v3/cards/{id}/activate \
  --header 'Authorization: <api-key>' \
  --header 'memberId: <memberid>'

import requests

url = "https://{host}/challenge/v3/cards/{id}/activate"

headers = {
    "memberId": "<memberid>",
    "Authorization": "<api-key>"
}

response = requests.put(url, headers=headers)

print(response.text)

const options = {method: 'PUT', headers: {memberId: '<memberid>', Authorization: '<api-key>'}};

fetch('https://{host}/challenge/v3/cards/{id}/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/challenge/v3/cards/{id}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "memberId: <memberid>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/challenge/v3/cards/{id}/activate"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("memberId", "<memberid>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/challenge/v3/cards/{id}/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["memberId"] = '<memberid>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "hideInList": true,
  "isActive": true,
  "currentProgress": 123,
  "cardsActivatedCount": 123,
  "closedAt": "2023-11-07T05:31:56Z",
  "cardId": "<string>",
  "currentTier": 123,
  "cardDetails": {
    "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "activityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "requiredProgress": 123,
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "imageUrl": "<string>",
    "details": "<string>",
    "termsAndConditions": "<string>",
    "activationLimit": 123,
    "backgroundImageUrl": "<string>",
    "chainIds": [
      "<string>"
    ],
    "storeIds": [
      "<string>"
    ],
    "rewardType": "Coupon",
    "progressCalculationType": "ProductCount",
    "isSinglePurchase": true,
    "completionLabel": "<string>",
    "completedCardsLabel": "<string>",
    "completedCardsCount": 123,
    "progressLabel": "<string>",
    "unitOfMeasure": "Item",
    "couponRewards": [
      {
        "offerId": "<string>"
      }
    ],
    "bonusRewards": [
      {
        "bonusAmount": 123
      }
    ],
    "customRewards": [
      {
        "name": "<string>"
      }
    ],
    "tags": [
      "<string>"
    ]
  }
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

PUT

cards

{id}

activate

Activate challenge

curl --request PUT \
  --url https://{host}/challenge/v3/cards/{id}/activate \
  --header 'Authorization: <api-key>' \
  --header 'memberId: <memberid>'

import requests

url = "https://{host}/challenge/v3/cards/{id}/activate"

headers = {
    "memberId": "<memberid>",
    "Authorization": "<api-key>"
}

response = requests.put(url, headers=headers)

print(response.text)

const options = {method: 'PUT', headers: {memberId: '<memberid>', Authorization: '<api-key>'}};

fetch('https://{host}/challenge/v3/cards/{id}/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/challenge/v3/cards/{id}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "memberId: <memberid>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/challenge/v3/cards/{id}/activate"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("memberId", "<memberid>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/challenge/v3/cards/{id}/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["memberId"] = '<memberid>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "hideInList": true,
  "isActive": true,
  "currentProgress": 123,
  "cardsActivatedCount": 123,
  "closedAt": "2023-11-07T05:31:56Z",
  "cardId": "<string>",
  "currentTier": 123,
  "cardDetails": {
    "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "activityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "requiredProgress": 123,
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "imageUrl": "<string>",
    "details": "<string>",
    "termsAndConditions": "<string>",
    "activationLimit": 123,
    "backgroundImageUrl": "<string>",
    "chainIds": [
      "<string>"
    ],
    "storeIds": [
      "<string>"
    ],
    "rewardType": "Coupon",
    "progressCalculationType": "ProductCount",
    "isSinglePurchase": true,
    "completionLabel": "<string>",
    "completedCardsLabel": "<string>",
    "completedCardsCount": 123,
    "progressLabel": "<string>",
    "unitOfMeasure": "Item",
    "couponRewards": [
      {
        "offerId": "<string>"
      }
    ],
    "bonusRewards": [
      {
        "bonusAmount": 123
      }
    ],
    "customRewards": [
      {
        "name": "<string>"
      }
    ],
    "tags": [
      "<string>"
    ]
  }
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

Authorizations

Authorization

string

header

required

Opaque Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Headers

memberId

string

required

Path Parameters

string

required

Response

hideInList

boolean

required

Configuration to make the challenge card invisible.

isActive

boolean

Specifies if the card can accumulate progress. True after manual activation, or automatically for preactivated challenges.

currentProgress

number<double>

Progress accumulated for the specific instance of challenge. Can be integer when calculation types are ProductCount and StoreVisit, or a float value otherwise.

cardsActivatedCount

integer<int32>

Amount of cards that user has activated in the given challenge. Includes current card, if it was activated.

closedAt

string<date-time> | null

Populated only if the card was already completed. Such cards no longer accumulate progress, so user can see what they already completed. Closed cards are returned until their challenge expires.

cardId

string | null

Id of the specific card. If challenge is renewable, this id will be different on each of the cards, while ActivityId will be the same. Will be null, if card is not activated.

currentTier

integer<int32> | null

The highest tier reached on this card. Null for non-tiered challenges or when no tier has been reached yet.

cardDetails

object

Show child attributes

Last modified on August 10, 2026

⌘I