Enroll members Coming soon

POST/v1/challenges/{id}/enrollments

Enrolls up to 500 members in a live challenge, without them tapping join. Use it to put a segment from your own tools into a challenge. Members already enrolled are skipped.

Permissions: Secret key with challenges:write.

Guide

Challenges

Request headers#

Idempotency-KeystringRequired
Required on this endpoint. Any string up to 255 characters; use a UUID v4. Missing returns 400 idempotency_key_required.
Max Length 255

Path parameters#

idstring (uuid)Required

Request body#

member_idsarray of string (uuid)Required
1 to 500 member ids.
Max Items 500

reason is already_enrolled, member_not_found or member_deleted.

Response fields#

Returns 200 with EnrollmentResult

enrolledinteger
skippedarray of Skipped
Show attributesSkipped
- member_idstring (uuid)
- reasonstring

POST/v1/challenges/{id}/enrollments

1
2
3
4
5
6
7
8
9
10curl -X POST https://api.unplugdining.com/v1/challenges/d1e83b5c-7f02-4a69-9c4e-5b1a07d8e236/enrollments \
  -H "Authorization: Bearer $UNPLUG_KEY" \
  -H "Idempotency-Key: 3b8e1d64-0a5f-4c92-b7e3-6d2f9a1c5e08" \
  -H "Content-Type: application/json" \
  -d '{
    "member_ids": [
      "3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40",
      "9a4d2f6b-1c8e-4b73-a0d5-e7f3c19b6284"
    ]
  }'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15const response = await fetch("https://api.unplugdining.com/v1/challenges/d1e83b5c-7f02-4a69-9c4e-5b1a07d8e236/enrollments", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
    "Idempotency-Key": "3b8e1d64-0a5f-4c92-b7e3-6d2f9a1c5e08",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    member_ids: [
      "3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40",
      "9a4d2f6b-1c8e-4b73-a0d5-e7f3c19b6284",
    ],
  }),
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17import os
import requests

response = requests.post(
    "https://api.unplugdining.com/v1/challenges/d1e83b5c-7f02-4a69-9c4e-5b1a07d8e236/enrollments",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
        "Idempotency-Key": "3b8e1d64-0a5f-4c92-b7e3-6d2f9a1c5e08",
    },
    json={
        "member_ids": [
            "3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40",
            "9a4d2f6b-1c8e-4b73-a0d5-e7f3c19b6284",
        ],
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6{
  "enrolled": 1,
  "skipped": [
    { "member_id": "3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40", "reason": "already_enrolled" }
  ]
}

Error descriptions#

400Bad request

idempotency_key_required

The header is missing.

400Bad request

invalid_param

More than 500 member_ids.

409Conflict

invalid_state

The challenge isn't live.

422Unprocessable

challenge_not_joinable

The challenge has used its budget.

Any endpoint can also return the common errors.

400 Bad request

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#idempotency_key_required",
  "title": "Bad request",
  "status": 400,
  "code": "idempotency_key_required",
  "detail": "The header is missing."
}