Skip to content

Events · Hosts​

Hosting an event (#2483): start and edit it, its days and Fundly shares, ticket types, co-hosts, volunteers, sponsors, photos and recap, submit, duplicate, postpone and cancel; and the caller's own lists. An event's routes are for its accepted hosts (whoever acts for an accepted host row: the member, a non-profit or church's owners and admins, a community's owner and leaders, a sponsor's owner and admins) and staff with manage_events; anyone else gets 404. A rule's refusal is 409 not_allowed with details.reason, the same i18n key the page's viewer block shows. Behind features.events.


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​


Delete a draft​

DELETE
/events/{id}

An event that never went live (draft, changes requested or rejected). It is kept, marked deleted, and answers 404 from then on.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Responses​

Done.

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Edit an event​

PATCH
/events/{id}

Saved as the host types. Editable until the event ends (not when rejected, cancelled, or, for hosts, suspended). A venue sets the city to the venue's. On a live event a changed place is published as event.rescheduled; a live event must keep a title and a place. Answers with the page.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
"string"

Responses​

The page after the change.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Check an event link​

GET
/events/{id}/slug-check

May this event use the link: not invalid, not reserved, not another event's (now or before). The event's own earlier links are free for it.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Query Parameters

slug*
Type
string
Required

Responses​

The answer.

application/json
JSON
{
"slug": "string",
"available": true,
"reason": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Save the days​

PUT
/events/{id}/days

The whole list (at most 14), each ending after it starts; sorted by start. A day keeps its id when the list names it. Removing a day a ticket type is for answers 409 day_in_use. A live event keeps at least one day; a changed date or time on it is published as event.rescheduled.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"days": [
{
"id": "string",
"starts_at": "string",
"ends_at": "string"
}
]
}

Responses​

The days.

application/json
JSON
{
"days": [
]
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Save the Fundlies and their shares​

PUT
/events/{id}/fundraisers

The whole list: 1 to 10 Fundlies, whole-percent shares of 1 to 100, adding up to no more than 100, exactly 100 on a live event (shares_must_total_100). A Fundly newly linked must be live and taking gifts (fundraiser_not_open, details.fundraiser_ids). Other refusals: too_many_fundraisers, duplicate_fundraiser, share_out_of_range, shares_over_100.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"fundraisers": [
{
"fundraiser_id": "string",
"share_percent": 0
}
]
}

Responses​

The shares.

application/json
JSON
{
"fundraisers": [
]
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Submit for review​

POST
/events/{id}/submit

Needs a verified email, a title, a date, a place (a venue, online, or to be announced), Fundly shares adding up to 100 and a ticket type (event_incomplete, details.problems are i18n keys). Hosts send it to staff review (event.submitted); staff with manage_events publish it at once (event.approved, not reviewed).

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Responses​

The new status.

application/json
JSON
{
"status": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Duplicate an event​

POST
/events/{id}/duplicate

A new draft with the event's details, days, Fundly shares, ticket types (not stopped or code-only ones) and volunteer roles, hosted by the host the caller acts for.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Responses​

The copy.

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

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Postpone a live event​

POST
/events/{id}/postpone

With new days, or none for "new date coming". Tickets stay valid. Published as event.postponed.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"days": [
{
"id": "string",
"starts_at": "string",
"ends_at": "string"
}
]
}

Responses​

The page.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Cancel a live event​

POST
/events/{id}/cancel

Sales stop and the page says it is cancelled; it stays up so shared links still explain. Published as event.cancelled. Refunds arrive with tickets (phase 6).

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Responses​

The page.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Add a ticket type​

POST
/events/{id}/ticket-types

At most 20. A free event's types are $0 (free_event_price); the value of the dinner is at most the price; "only with a code" needs access_code; "members of a host community" needs a community host (no_host_community); a "one day each" event gives each type its day (day_required, unknown_day).

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"name": "string",
"description": "string",
"price_cents": 0,
"goods_value_cents": 0,
"seats_per_ticket": 0,
"quantity": 0,
"sales_start": "string",
"sales_end": "string",
"min_per_order": 0,
"max_per_order": 0,
"access": "string",
"access_code": "string",
"hidden": true,
"event_day_id": "string"
}

Responses​

The type.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Delete a ticket type​

DELETE
/events/{id}/ticket-types/{typeId}

Only one that never sold (ticket_type_has_sales); a free event keeps one open RSVP type (rsvp_type_required).

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
typeId*

The ticket type.

Type
string
Required
Format
"uuid"

Responses​

Done.

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Change a ticket type​

PATCH
/events/{id}/ticket-types/{typeId}

Only while it has sold nothing (ticket_type_has_sales) and is not stopped (ticket_type_stopped); the same rules as adding.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
typeId*

The ticket type.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
"string"

Responses​

The type.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Stop selling a ticket type​

POST
/events/{id}/ticket-types/{typeId}/stop

Its tickets stay valid. The way to end a type that has sold.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
typeId*

The ticket type.

Type
string
Required
Format
"uuid"

Responses​

The type.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Save the co-host list​

PUT
/events/{id}/hosts

The editor's whole host list, including any explicitly selected platform row, saved atomically by draft autosave or live Save changes. Omitted rows are removed; existing rows keep their status unless a super administrator explicitly accepts a pending invitation with accept_without_invitation: true. Adding platform requires super_admin or ambassador; an authorized editor can keep or remove an existing platform row. Non-staff must keep one accepted host (last_host). Invitations and acceptance events are sent only after commit, once; repeating the saved list sends no duplicate invitation or acceptance.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"hosts": [
]
}

Responses​

What the save changed.

application/json
JSON
{
"added": [
{
"id": "string",
"status": "string",
"target": {
"kind": "string",
"id": "string"
}
}
],
"removed": [
"string"
]
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Invite a co-host​

POST
/events/{id}/hosts

A member, non-profit or church, community or sponsor business. It shows on the page once it accepts (event_host.invited); one the caller acts for is added accepted at once (event_host.accepted). An explicit super-admin override accepts immediately without sending an invitation. Only a super administrator or ambassador can add FundlyHub as an explicit platform host. A declined host can be invited again. At most 10.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
"string"

Responses​

The host row.

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

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Remove a co-host​

DELETE
/events/{id}/hosts/{hostId}

An authorized editor can remove any host including an explicit FundlyHub row; the event keeps one accepted host (last_host, staff excepted).

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
hostId*

The host row.

Type
string
Required
Format
"uuid"

Responses​

Done.

Playground​

Server
Authorization
Variables
Key
Value

Samples​


The Volunteers tab​

GET
/events/{id}/volunteers

The roles with filled and open slots, and everyone in them.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Responses​

Roles and volunteers.

application/json
JSON
{
"roles": [
],
"volunteers": [
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Add a volunteer role​

POST
/events/{id}/volunteer-roles

At most 30.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"name": "string",
"description": "string",
"starts_at": "string",
"ends_at": "string",
"slots": 0,
"signup": "string",
"can_check_in": true,
"can_upload_photos": true,
"free_seat": true
}

Responses​

The role.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Delete a volunteer role​

DELETE
/events/{id}/volunteer-roles/{roleId}

With everyone in it.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
roleId*

The role.

Type
string
Required
Format
"uuid"

Responses​

Done.

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Change a volunteer role​

PATCH
/events/{id}/volunteer-roles/{roleId}

Slots never drop below the people confirmed (slots_below_confirmed).

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
roleId*

The role.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
"string"

Responses​

The role.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Add a volunteer​

POST
/events/{id}/volunteer-roles/{roleId}/volunteers

A member (profile_id, invited) or someone without an account (name and email, confirmed; role_full when every slot is filled).

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
roleId*

The role.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
"string"

Responses​

The volunteer.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Remove a volunteer​

DELETE
/events/{id}/volunteers/{volunteerId}

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
volunteerId*

The volunteer.

Type
string
Required
Format
"uuid"

Responses​

Done.

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Change a volunteer​

PATCH
/events/{id}/volunteers/{volunteerId}

Name, email, phone and note.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
volunteerId*

The volunteer.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
"string"

Responses​

The volunteer.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Approve a sign-up​

POST
/events/{id}/volunteers/{volunteerId}/approve

A requested sign-up becomes confirmed (not_requested, role_full).

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
volunteerId*

The volunteer.

Type
string
Required
Format
"uuid"

Responses​

The volunteer.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Decline a sign-up or an invitation​

POST
/events/{id}/volunteers/{volunteerId}/decline

not_pending otherwise.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
volunteerId*

The volunteer.

Type
string
Required
Format
"uuid"

Responses​

The volunteer.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


The Sponsors tab​

GET
/events/{id}/sponsors

Every sponsor, with the hosts' bookkeeping, and the requests from the page, newest first.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Responses​

Sponsors and requests.

application/json
JSON
{
"sponsors": [
],
"requests": [
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Add a sponsor​

POST
/events/{id}/sponsors

At most 50; one presenting sponsor (presenting_sponsor_taken); each FundlyHub partner once (sponsor_already_added); a partner the candidate search would not show is not_found.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
"string"

Responses​

The sponsor.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Reorder the sponsors​

PUT
/events/{id}/sponsors/order

Every sponsor id once, in the new order (order_mismatch).

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"ids": [
"string"
]
}

Responses​

The sponsors.

application/json
JSON
{
"sponsors": [
]
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Remove a sponsor​

DELETE
/events/{id}/sponsors/{sponsorId}

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
sponsorId*

The sponsor row.

Type
string
Required
Format
"uuid"

Responses​

Done.

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Change a sponsor​

PATCH
/events/{id}/sponsors/{sponsorId}

A FundlyHub partner's name, logo and page come from its own page (fundlyhub_sponsor_profile).

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
sponsorId*

The sponsor row.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
"string"

Responses​

The sponsor.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Delete a sponsor request​

DELETE
/events/{id}/sponsor-requests/{requestId}

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
requestId*

The request.

Type
string
Required
Format
"uuid"

Responses​

Done.

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Answer a sponsor request​

PATCH
/events/{id}/sponsor-requests/{requestId}

Mark it replied, added or dismissed. Stays open after the event.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
requestId*

The request.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"status": "string"
}

Responses​

The request.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


The gallery​

GET
/events/{id}/photos

Every photo, those to review and hidden too.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Responses​

Photos.

application/json
JSON
{
"photos": [
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Add a photo​

POST
/events/{id}/photos

Uploaded with POST /storage/upload. Hosts add it shown (optionally as the cover); a confirmed volunteer in a role that may upload photos may add one too, and it waits as to_review. At most 200.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"url": "string",
"is_cover": true,
"focal_x": 0,
"focal_y": 0
}

Responses​

The photo.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Reorder the gallery​

PUT
/events/{id}/photos/order

Every photo id once, in the new order (order_mismatch).

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"ids": [
"string"
]
}

Responses​

Photos.

application/json
JSON
{
"photos": [
]
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Delete a photo​

DELETE
/events/{id}/photos/{photoId}

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
photoId*

The photo.

Type
string
Required
Format
"uuid"

Responses​

Done.

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Show, hide or make the cover​

PATCH
/events/{id}/photos/{photoId}

The cover is one shown photo (cover_must_show); only a hidden photo has a reason (reason_for_hidden_only).

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
photoId*

The photo.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"status": "string",
"hidden_reason": "string",
"is_cover": true,
"focal_x": 0,
"focal_y": 0
}

Responses​

The photo.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Write the recap​

PATCH
/events/{id}/recap

Any time a live event is not cancelled; published once it has ended.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
"string"

Responses​

The recap.

application/json
JSON
{
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Publish the recap​

POST
/events/{id}/recap/publish

Once the event has ended (not_allowed, events.viewer.reasons.not_ended before). Published as event.recap_published, with whether to email the guests.

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)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"email_guests": true
}

Responses​

The page.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Accept a co-host invitation​

POST
/event-hosts/{id}/accept

By someone who acts for the invited host. The host then shows on the page (event_host.accepted).

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)

Parameters​

Path Parameters

id*

The invitation (host row).

Type
string
Required
Format
"uuid"

Responses​

Accepted.

application/json
JSON
{
"id": "string",
"event_id": "string",
"status": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Decline a co-host invitation​

POST
/event-hosts/{id}/decline

By someone who acts for the invited host.

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)

Parameters​

Path Parameters

id*

The invitation (host row).

Type
string
Required
Format
"uuid"

Responses​

Declined.

application/json
JSON
{
"id": "string",
"event_id": "string",
"status": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Your events​

GET
/me/events

Hosting: every event (any state but deleted) with an accepted host the caller acts for, latest first (items); with as, only the events that one identity hosts (a workspace's Events tab, #2494). Going (#2487): every event the caller holds tickets for, as the buyer or a guest named on a ticket, as upcoming (soonest first) and past (latest first), each row with their tickets.

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)

Parameters​

Query Parameters

tab
Type
string
Valid values
"hosting""going"
Default
"hosting"

Responses​

Rows.

application/json
JSON
{
"items": [
],
"upcoming": [
],
"past": [
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Co-host invitations for you​

GET
/me/event-host-invitations

Invitations naming the caller or a non-profit, church, community or sponsor they act for, newest first; with as, only those naming that one identity (#2494). Each invitation also reaches the people who can answer it as a bell notice and an email (event_host_invited, metadata hostId).

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)

Parameters​

Responses​

Invitations.

application/json
JSON
{
"items": [
{
"id": "string",
"as": {
"kind": "string",
"id": "string",
"name": "string"
},
"invited_at": "string",
"event": "string"
}
]
}

Playground​

Server
Authorization

Samples​


Find an Event member, co-host or sponsor identity​

GET
/me/event-candidates

A fresh authenticated identity lookup for Event editors. Names and profile handles are searched directly; no email or private biography is searched or returned. Inactive/deleting members are excluded. Sponsor choices do not require discoverable perks: public sponsor pages are available, while private applications require current sponsor-team or sponsor-specific staff authority. Returned identity fields are minimal. Responses use private, no-store caching and vary by Cookie and Authorization.

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)

Parameters​

Query Parameters

q

Fewer than two characters return no choices.

Type
string
Max Length
80
kind
Type
string
Valid values
"all""member""organization""community""sponsor"
Default
"all"
limit
Type
integer
Minimum
1
Maximum
20
Default
10

Responses​

Matching identities, without private contact or sponsor bookkeeping fields.

application/json
JSON
{
"items": [
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Who you can host as​

GET
/me/event-identities

The identities the caller can host an event as (#2494): themself, and each non-profit, church, community and sponsor business they act for; staff publishing access and separate strict role-based host capabilities. Platform choice is for super administrators or ambassadors; consent override is for super administrators only. The app shows its Events tabs and "Host an event" only once this answers 200: a 404 means Events are switched off for the caller.

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)

Responses​

Identities.

application/json
JSON
{
"items": [
{
"kind": "string",
"id": "string",
"name": "string"
}
],
"staff": true,
"can_accept_host_invitations": true,
"can_host_as_platform": true
}

Playground​

Server
Authorization

Samples​


Saved venues​

GET
/me/event-venues

The open premises (with an address) of the non-profits, churches, communities and sponsors the caller acts for, to pick as a venue (venue_place_id).

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)

Responses​

Venues.

application/json
JSON
{
"items": [
{
"id": "string",
"label": "string",
"owner": {
"kind": "string",
"id": "string",
"name": "string"
},
"place": {
"additionalProperties": "string"
}
}
]
}

Playground​

Server
Authorization

Samples​


Powered by VitePress OpenAPI

Built with VitePress