Join a challenge Coming soon

POST/v1/members/me/challenges/{id}/join

Enrolls the member in an opt_in challenge. Returns the member challenge with status: "enrolled". For a rolling challenge, the member's window starts now. Joining a challenge the member is already in returns their current state, so a retry after a timeout is safe.

Permissions: Member token.

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
The challenge.

Response fields#

Returns 200 with MemberChallenge

challenge_idstring (uuid)
The challenge.
member_idstring (uuid)
statusstring
eligible (can join, not joined), enrolled, completed or expired.
One of eligible, enrolled, completed, expired
progressobject
current, target and unit. For streaks, periods lists each day or week with starts_at, ends_at and met; it's empty for other types.
Show attributesHide attributes
- currentinteger
- targetinteger
- unitstring
  One of visits, periods, cents, items
- periodsarray of object
  Show attributesHide attributes
  - starts_atstring (date-time)
  - ends_atstring (date-time)
  - metboolean
window_ends_atstring (date-time)Nullable
When this member's window ends. For a rolling challenge they haven't joined, null.
completed_atstring (date-time)Nullable
When they completed it, or null.
reward_wallet_item_idstring (uuid)Nullable
The wallet item paid on completion, for catalog rewards. null otherwise.

POST/v1/members/me/challenges/{id}/join

1
2curl -X POST https://api.unplugdining.com/v1/members/me/challenges/d1e83b5c-7f02-4a69-9c4e-5b1a07d8e236/join \
  -H "Authorization: Bearer mt_4kQ9xV2mR7tB8nW3pL6yZ1cH5fJ0dS"

1
2
3
4
5
6
7const response = await fetch("https://api.unplugdining.com/v1/members/me/challenges/d1e83b5c-7f02-4a69-9c4e-5b1a07d8e236/join", {
  method: "POST",
  headers: {
    Authorization: "Bearer mt_4kQ9xV2mR7tB8nW3pL6yZ1cH5fJ0dS",
  },
});
const data = await response.json();

1
2
3
4
5
6
7
8
9import requests

response = requests.post(
    "https://api.unplugdining.com/v1/members/me/challenges/d1e83b5c-7f02-4a69-9c4e-5b1a07d8e236/join",
    headers={
        "Authorization": "Bearer mt_4kQ9xV2mR7tB8nW3pL6yZ1cH5fJ0dS",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15{
  "challenge_id": "d1e83b5c-7f02-4a69-9c4e-5b1a07d8e236",
  "status": "enrolled",
  "progress": {
    "current": 0,
    "target": 4,
    "unit": "periods",
    "periods": [
      { "starts_at": "2026-11-02T06:00:00Z", "ends_at": "2026-11-09T06:00:00Z", "met": false }
    ]
  },
  "window_ends_at": "2026-12-07T06:00:00Z",
  "completed_at": null,
  "reward_wallet_item_id": null
}

Error descriptions#

422Unprocessable

challenge_not_joinable

The challenge is automatic, isn't live, has used its budget, or isn't open to this member. detail says which.

404Not found

not_found

No such challenge.

Any endpoint can also return the common errors.

422 Unprocessable

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#challenge_not_joinable",
  "title": "Unprocessable",
  "status": 422,
  "code": "challenge_not_joinable",
  "detail": "The challenge is automatic, isn't live, has used its budget, or isn't open to this member. detail says which."
}