Skip to content

Start an event (a draft)​

POST
/events

A new draft with its main host: an identity the caller acts for (host: themselves, a non-profit or church they manage, a community they lead, a sponsor they own; themselves when left out). FundlyHub is never automatically added. A super administrator or ambassador can explicitly select {kind: platform, id: null}. Only a super administrator may select another identity with accept_without_invitation: true. time_zone is required; anything else already typed may come along. A free event gets its RSVP ticket type. The link is made from the title when not given.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Request Body​

application/json
JSON
{
"slug": "string",
"title": "string",
"subtitle": "string",
"about_html": "string",
"program": [
{
"time": "string",
"label": "string"
}
],
"category": "string",
"cover_image": "string",
"cover_image_focal_x": 0,
"cover_image_focal_y": 0,
"cover_video_url": "string",
"page_theme": "string",
"attendance": "string",
"online_url": "string",
"venue_place_id": "string",
"venue_address": {
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string",
"lat": 0,
"lng": 0
},
"venue_name": "string",
"venue_details": "string",
"venue_tba": true,
"city_place_id": "string",
"address_visibility": "string",
"time_zone": "America/Los_Angeles",
"registration": "string",
"capacity": 0,
"vip_reserved_seats": 0,
"plus_ones": 0,
"ticket_scope": "string",
"approval_required": true,
"waitlist_enabled": true,
"guests_without_account": true,
"ask_guest_details": true,
"show_attendees": true,
"guest_list_public": true,
"gift_prompt": true,
"count_ticket_money": true,
"free_cancellation_until": "string",
"listed": true,
"members_only_community_id": "string"
}

Responses​

The draft.

application/json
JSON
{
"id": "string",
"slug": "string"
}

Playground​

Server
Authorization
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress