/events/{fancyId}

This endpoint is used to modify an event’s details. Attributes that can be changed are the event name, description, country, city, start date, end date, expire date, and URL. The image cannot be updated.

Note: An event can only be edited within 30 days of the event start date.

Path Params
string
required

A string that uniquely identifies the event. This is generated based on the event name at event creation and cannot be edited.

Body Params
string
required
length ≤ 256

The name of the event.

string
required
length ≤ 1500

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

string
required
length ≤ 256

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

string
required
length ≤ 256

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

date
required

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

date
required

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

date
required

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

string
required

The URL of a website the attendees should visit.

boolean
Defaults to false

Whether the event is virtual.

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.

number
Defaults to 1

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

string
required

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"

Response

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json