Create Calendar

post

https://public-api.luma.com/v2/organizations/calendars/create

Create a new calendar within the organization. The calendar will be managed by the API key owner.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

Name of the calendar.

slug

string

URL slug for the calendar page (e.g. 'my-community' → lu.ma/my-community).

description

string

Short description of the calendar.

avatar_url

uri

Specify an image that has been uploaded to the Luma CDN. If not provided, a random default avatar will be used.

tint_color

string

Tint color for the calendar in hex format (e.g. '#E3CBEF'). If not provided, a random color matching the default avatar will be used.

launch_status

string

enum

Defaults to launched (Active). Use coming-soon to show a placeholder page while you set the calendar up.

Allowed:

website

string | null

Website URL. https:// is added if missing.

instagram_handle

string | null

Instagram handle or profile URL (e.g. 'luma' or 'https://instagram.com/luma').

twitter_handle

string | null

X (Twitter) handle or profile URL (e.g. '@luma' or 'https://x.com/luma').

youtube_handle

string | null

YouTube handle or channel URL (e.g. '@luma' or 'https://youtube.com/@luma').

tiktok_handle

string | null

TikTok handle or profile URL (e.g. '@luma' or 'https://tiktok.com/@luma').

linkedin_handle

string | null

LinkedIn company or profile URL (e.g. 'https://linkedin.com/company/luma').

location

City the calendar is based in. Use { type: 'lookup', query } to search Google Maps for a city, or { type: 'google', place_id } with a city's Google Places ID. The calendar's timezone and coordinate come from the city.

Response

200Successful response.