List challenge templates Coming soon

GET/v1/challenge_templates

Returns the template pack: Weekly regular, 4-week streak, Seasonal discovery, Afternoon pick-me-up, Breakfast pairing, Order ahead, Win-back and Bean bag. A template has the challenge fields without dates or a catalog reward. window_days is the window length to use, and suggested_reward says what usually works; pick the reward from your catalog when you create the challenge.

Permissions: Secret key with challenges:write.

Guide

Challenges

Query parameters#

limitinteger
Min 1Max 100Default 25
cursorstring
next_cursor from the previous page.

Response fields#

Returns 200 with list of ChallengeTemplate

dataarray of ChallengeTemplate
Show attributesChallengeTemplate
- idstring
- namestring
- descriptionstring
- typestring
- goalobject
- qualifyingobject
- window_kindstring
  One of fixed, rolling
- window_daysinteger
- enrollmentstring
  One of automatic, opt_in
- suggested_rewardstring
has_moreboolean
True when another page exists.
next_cursorstringNullable
Pass as cursor to get the next page.

GET/v1/challenge_templates

1
2curl "https://api.unplugdining.com/v1/challenge_templates?limit=2" \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6const response = await fetch("https://api.unplugdining.com/v1/challenge_templates?limit=2", {
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
  },
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10import os
import requests

response = requests.get(
    "https://api.unplugdining.com/v1/challenge_templates?limit=2",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30{
  "data": [
    {
      "id": "weekly_regular",
      "name": "Weekly regular",
      "description": "3 visits Monday to Sunday.",
      "type": "visits",
      "goal": { "target": 3, "unit": "visits", "period": null, "grace_periods": null, "item_set": [] },
      "qualifying": { "min_subtotal_cents": 300, "channels": [], "location_ids": [], "fulfillment": [], "available_times": [], "max_counted_per_day": 1 },
      "window_kind": "fixed",
      "window_days": 7,
      "enrollment": "automatic",
      "suggested_reward": "Bonus points worth about one add-on"
    },
    {
      "id": "four_week_streak",
      "name": "4-week streak",
      "description": "A visit every week for 4 weeks, 1 grace week.",
      "type": "streak",
      "goal": { "target": 4, "unit": "periods", "period": "week", "grace_periods": 1, "item_set": [] },
      "qualifying": { "min_subtotal_cents": 300, "channels": [], "location_ids": [], "fulfillment": [], "available_times": [], "max_counted_per_day": 1 },
      "window_kind": "fixed",
      "window_days": 35,
      "enrollment": "opt_in",
      "suggested_reward": "Free drink"
    }
  ],
  "has_more": true,
  "next_cursor": "dGVtcGxhdGVfMg"
}