Skip to content

EventCreate

A new event, either with a fixed date (starts_at and ends_at) or with the candidate dates of a date poll (candidates), not both.

object
title
required

1 to 100 characters on one line.

string
description

Up to 3,000 characters of plain text; line breaks are kept.

string
visibility

Who sees the event; public when omitted.

string
Allowed values: public followers following mutuals invited
time_zone

The IANA name of the event’s time zone; the user’s time zone when omitted.

string
place_disclosure

Who sees the physical and url places; approved when omitted.

string
Allowed values: approved viewers
capacity

How many attendees may answer going, up to 10,000; 0 (the default) for no limit.

integer
board_writers

Who posts on the event’s board; organizers when omitted.

string
Allowed values: organizer organizers readers
places

Up to 3 places, one of each kind.

Array<object>

A place of an event. A physical place has a name, an address, and an optional map link in url; a url place has a name and a url; a voice place has speakers, who may speak without asking in the voice chat room that opens when the event starts. A URL is an http or https URL of up to 2,000 characters, which the server never fetches. The fields that a kind does not have are omitted.

object
kind
required

The kind of a place: voice a voice chat room of this server, physical a place to meet in person, and url a link such as a stream or a meeting of another service.

string
Allowed values: voice physical url
name

Up to 100 characters on one line.

string
address

Up to 500 characters; line breaks are kept.

string
url
string
speakers

Who may speak without asking in the room; manual when omitted.

string
Allowed values: everyone followers following mutuals manual
room_id

For a voice place, the voice chat room that the start of the event’s current date opened (GET /voice/rooms/{id}), which may have ended since; omitted before the room opens. Ignored in a request.

string format: uuid
room_unavailable

For a voice place, why the room of the event’s current date could not open at the start; omitted otherwise. Ignored in a request.

string
Allowed values: disabled not_eligible too_many_rooms hosting_elsewhere
starts_at

After now and at most a year ahead.

string format: date-time
ends_at

After starts_at and at most 7 days later.

string format: date-time
candidates

1 to 20 different candidate dates, each checked as a fixed date: the event is unscheduled until the organizers confirm one of them.

Array<object>

A candidate date of an event’s date poll, in UTC.

object
starts_at
required

After now and at most a year ahead.

string format: date-time
ends_at
required

After starts_at and at most 7 days later.

string format: date-time

Example generated

{
"title": "example",
"description": "example",
"visibility": "public",
"time_zone": "example",
"place_disclosure": "approved",
"capacity": 1,
"board_writers": "organizer",
"places": [
{
"kind": "voice",
"name": "example",
"address": "example",
"url": "example",
"speakers": "everyone"
}
],
"starts_at": "2026-04-15T12:00:00Z",
"ends_at": "2026-04-15T12:00:00Z",
"candidates": [
{
"starts_at": "2026-04-15T12:00:00Z",
"ends_at": "2026-04-15T12:00:00Z"
}
]
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site