Preview a challenge Coming soon

POST/v1/challenges/{id}/preview

A dry run with no side effects. It estimates the audience, how many members will complete the challenge based on their past orders, and what the rewards will cost. Warnings flag a goal that looks too easy (more than about 80% expected to complete) or too hard (under about 10%).

expected_points is the bonus points to be paid. expected_cost_cents is the discount value of catalog rewards to be paid. Weekly regular pays points only: 640 completions times 50 Beans.

Permissions: Secret key with challenges:write.

Guide

Challenges

Request headers#

Idempotency-Keystring
Any string up to 255 characters; use a UUID v4. Kept 24 hours per key (or member) and endpoint. Same key and body replays the first response with Idempotent-Replayed: true.
Max Length 255

Path parameters#

idstring (uuid)Required

Response fields#

Returns 200 with ChallengePreview

audience_membersinteger
expected_completionsinteger
expected_pointsinteger
expected_cost_centsinteger
warningsarray of string

POST/v1/challenges/{id}/preview

1
2curl -X POST https://api.unplugdining.com/v1/challenges/4f9a2d61-3e8b-4c15-a7d0-b26e81f5c93a/preview \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6
7const response = await fetch("https://api.unplugdining.com/v1/challenges/4f9a2d61-3e8b-4c15-a7d0-b26e81f5c93a/preview", {
  method: "POST",
  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.post(
    "https://api.unplugdining.com/v1/challenges/4f9a2d61-3e8b-4c15-a7d0-b26e81f5c93a/preview",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7{
  "audience_members": 3120,
  "expected_completions": 640,
  "expected_points": 32000,
  "expected_cost_cents": 0,
  "warnings": []
}

Error descriptions#

404Not found

not_found

No such challenge.

Any endpoint can also return the common errors.