/secret-requests

post https://api.poap.tech/secret-requests

This endpoint is used to create a new secret word claim for a specific event. Secret word is a distribution method where POAPs can be claimed by using the specified secret word. This method only works on mobile when used with POAP Mobile app.

To prevent someone from guessing your secret word, please use a generated randomized phrase (eg: increase-group-student), and keep your mint window open for less than 10 minutes.

Once the "word" or "website" is created, it's intended to be shared with your collectors to claim their POAP.

Note: "word" is not compatible for claiming via API.
If using secret word, direct collectors to enter the secret word into POAP Mobile app.
If using "website", access via browser. If POAP Mobile app is on device when accessing "website", this will re-direct to POAP Mobile app and mint.

Body Params

event_id

number

required

The numeric ID of the event.

requested_codes

number

required

The number of POAP codes that were requested for this secret.

secret_code

string

A six-digit numeric key defined when the event was created and is used to authorize performing certain actions on an event. Note: It's also call "Edit Code"

claim_name

string

required

The name of the secret claim. This is the claim_name entered when creating a Website or Secret Word claim.

from

date-time

required

The date from which the secret is valid. Must be ISO format YYYY-MM-DDTHH-MM-SSZ.

date-time

required

The date to which the secret is valid. Must be ISO format YYYY-MM-DDTHH-MM-SSZ.

timezone

number

-12 to 12

Defaults to 0

The timezone UTC offset for the secret date.

active

boolean

Defaults to true

Whether the secret is active.

secret_type

string

required

Response

xxxxxxxxxx
curl --request POST \
     --url https://api.poap.tech/secret-requests \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "timezone": 0,
  "active": true,
  "secret_type": "word"
}
'

200Success