/events

post

https://api.poap.tech/events

This endpoint is used to create a new event. Please see the quality guidelines for responsible event creation and distribution as well as why it's important.

After submitting, an email will be sent to the provided email address confirming the creation of the event. A follow up email will be sent when the event has been approved or declined. If approved, the email will contain the requested mint-link codes for the event.

Note: For testing, please indicate that it's a test by adding 'test' on the artwork and title, mark the event as private, and request no more than 10 mint links.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length ≤ 256

The name of the event.

description

string

required

length ≤ 1500

The description of the event. Max length is 1500 characters.

city

string

required

length ≤ 256

The city where event takes place. This field is optional for virtual events.

country

string

required

length ≤ 256

The country where the event takes place. This field is optional for virtual events.

start_date

date

required

The start date of the event. Must be in YYYY-MM-DD or MM-DD-YYYY format.

end_date

date

required

The end date of the event. Must be in YYYY-MM-DD or MM-DD-YYYY format.

expiry_date

date

required

The limit date for POAPs to be claimable for the event. Must be in YYYY-MM-DD or MM-DD-YYYY format.

event_url

string

The URL of a website the attendees should visit.

virtual_event

boolean

required

Defaults to false

Whether the event is virtual.

image

file

required

The POAP image for the event. GIF, PNG and WebP images under 4 MB are supported.

secret_code

string

required

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

event_template_id

number

Defaults to 1

The ID of the event template for POAP’s claim page (https://app.poap.xyz/claim/xxxxxx).

string

required

length ≤ 256

The issuer's email address.

requested_codes

number

The number of codes requested for the event.

private_event

boolean

Defaults to false

If true, the event is private and will be filtered out in POAP’s frontend. Test events should be made private.

notify_issuer

boolean

Defaults to true

If false, the email with the mint links and the email with the edit code are not send

Response

200Success