LUluma
Organizations

Create Calendar

Changed on

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

post/v2/organizations/calendars/create

Request

Request body

namestring required

Name of the calendar.

slugstring

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

descriptionstring

Short description of the calendar.

avatar_urlstring uri

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

tint_colorstring

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'launched' | 'coming-soon' | 'archived'

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

websitestring nullable

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

instagram_handlestring nullable

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

twitter_handlestring nullable

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

youtube_handlestring nullable

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

tiktok_handlestring nullable

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

linkedin_handlestring nullable

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

Response

Successful response.

idstring required
launch_status'launched' | 'coming-soon' | 'archived' required

Calendar status: launched means Active; coming-soon shows a placeholder page; archived stops new follows and visitor event submissions.

tint_colorstring nullable required

A hex color like '#bb2dc7'. Shorthand (#rgb) is expanded and alpha channels (#rgba, #rrggbbaa) are stripped.

namestring required
slugstring nullable required
avatar_urlstring nullable required
urlstring required
descriptionstring nullable required
social_image_urlstring nullable required
cover_image_urlstring nullable required
is_personalboolean required
instagram_handlestring nullable required
twitter_handlestring nullable required
youtube_handlestring nullable required
tiktok_handlestring nullable required
linkedin_handlestring nullable required

LinkedIn path, e.g. '/company/luma' or '/in/username'.

websitestring nullable required

Changes

  • 51ca88b194afRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      response property avatar_url list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property cover_image_url list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property description list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property instagram_handle list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property location/anyOf[subschema #1]/country list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property location/anyOf[subschema #1]/country_code list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property location/anyOf[subschema #1]/region list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property slug list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property social_image_url list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property twitter_handle list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property website list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property youtube_handle list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status