Create Event

Create Event

curl --request POST \
  --url https://api.sublay.io/api/v6/:projectId/api/v7/events \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "startTime": "<string>",
  "type": "<string>",
  "description": "<string>",
  "endTime": "<string>",
  "timezone": "<string>",
  "url": "<string>",
  "venueName": "<string>",
  "address": "<string>",
  "location": {},
  "spaceId": "<string>",
  "visibility": "<string>",
  "capacity": 123,
  "allowMaybe": true,
  "guestListVisible": true,
  "hostIds": [
    "<string>"
  ],
  "metadata": {},
  "userId": "<string>",
  "cover.options": "<string>",
  "gallery": [
    null
  ],
  "gallery.options": "<string>"
}
'

import requests

url = "https://api.sublay.io/api/v6/:projectId/api/v7/events"

payload = {
    "title": "<string>",
    "startTime": "<string>",
    "type": "<string>",
    "description": "<string>",
    "endTime": "<string>",
    "timezone": "<string>",
    "url": "<string>",
    "venueName": "<string>",
    "address": "<string>",
    "location": {},
    "spaceId": "<string>",
    "visibility": "<string>",
    "capacity": 123,
    "allowMaybe": True,
    "guestListVisible": True,
    "hostIds": ["<string>"],
    "metadata": {},
    "userId": "<string>",
    "cover.options": "<string>",
    "gallery": [None],
    "gallery.options": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    startTime: '<string>',
    type: '<string>',
    description: '<string>',
    endTime: '<string>',
    timezone: '<string>',
    url: '<string>',
    venueName: '<string>',
    address: '<string>',
    location: {},
    spaceId: '<string>',
    visibility: '<string>',
    capacity: 123,
    allowMaybe: true,
    guestListVisible: true,
    hostIds: ['<string>'],
    metadata: {},
    userId: '<string>',
    'cover.options': '<string>',
    gallery: [null],
    'gallery.options': '<string>'
  })
};

fetch('https://api.sublay.io/api/v6/:projectId/api/v7/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sublay.io/api/v6/:projectId/api/v7/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'startTime' => '<string>',
    'type' => '<string>',
    'description' => '<string>',
    'endTime' => '<string>',
    'timezone' => '<string>',
    'url' => '<string>',
    'venueName' => '<string>',
    'address' => '<string>',
    'location' => [
        
    ],
    'spaceId' => '<string>',
    'visibility' => '<string>',
    'capacity' => 123,
    'allowMaybe' => true,
    'guestListVisible' => true,
    'hostIds' => [
        '<string>'
    ],
    'metadata' => [
        
    ],
    'userId' => '<string>',
    'cover.options' => '<string>',
    'gallery' => [
        null
    ],
    'gallery.options' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sublay.io/api/v6/:projectId/api/v7/events"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"startTime\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"endTime\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"url\": \"<string>\",\n  \"venueName\": \"<string>\",\n  \"address\": \"<string>\",\n  \"location\": {},\n  \"spaceId\": \"<string>\",\n  \"visibility\": \"<string>\",\n  \"capacity\": 123,\n  \"allowMaybe\": true,\n  \"guestListVisible\": true,\n  \"hostIds\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"userId\": \"<string>\",\n  \"cover.options\": \"<string>\",\n  \"gallery\": [\n    null\n  ],\n  \"gallery.options\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sublay.io/api/v6/:projectId/api/v7/events")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"startTime\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"endTime\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"url\": \"<string>\",\n  \"venueName\": \"<string>\",\n  \"address\": \"<string>\",\n  \"location\": {},\n  \"spaceId\": \"<string>\",\n  \"visibility\": \"<string>\",\n  \"capacity\": 123,\n  \"allowMaybe\": true,\n  \"guestListVisible\": true,\n  \"hostIds\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"userId\": \"<string>\",\n  \"cover.options\": \"<string>\",\n  \"gallery\": [\n    null\n  ],\n  \"gallery.options\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sublay.io/api/v6/:projectId/api/v7/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"startTime\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"endTime\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"url\": \"<string>\",\n  \"venueName\": \"<string>\",\n  \"address\": \"<string>\",\n  \"location\": {},\n  \"spaceId\": \"<string>\",\n  \"visibility\": \"<string>\",\n  \"capacity\": 123,\n  \"allowMaybe\": true,\n  \"guestListVisible\": true,\n  \"hostIds\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"userId\": \"<string>\",\n  \"cover.options\": \"<string>\",\n  \"gallery\": [\n    null\n  ],\n  \"gallery.options\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

POST

:projectId

api

events

Create Event

curl --request POST \
  --url https://api.sublay.io/api/v6/:projectId/api/v7/events \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "startTime": "<string>",
  "type": "<string>",
  "description": "<string>",
  "endTime": "<string>",
  "timezone": "<string>",
  "url": "<string>",
  "venueName": "<string>",
  "address": "<string>",
  "location": {},
  "spaceId": "<string>",
  "visibility": "<string>",
  "capacity": 123,
  "allowMaybe": true,
  "guestListVisible": true,
  "hostIds": [
    "<string>"
  ],
  "metadata": {},
  "userId": "<string>",
  "cover.options": "<string>",
  "gallery": [
    null
  ],
  "gallery.options": "<string>"
}
'

import requests

url = "https://api.sublay.io/api/v6/:projectId/api/v7/events"

payload = {
    "title": "<string>",
    "startTime": "<string>",
    "type": "<string>",
    "description": "<string>",
    "endTime": "<string>",
    "timezone": "<string>",
    "url": "<string>",
    "venueName": "<string>",
    "address": "<string>",
    "location": {},
    "spaceId": "<string>",
    "visibility": "<string>",
    "capacity": 123,
    "allowMaybe": True,
    "guestListVisible": True,
    "hostIds": ["<string>"],
    "metadata": {},
    "userId": "<string>",
    "cover.options": "<string>",
    "gallery": [None],
    "gallery.options": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    startTime: '<string>',
    type: '<string>',
    description: '<string>',
    endTime: '<string>',
    timezone: '<string>',
    url: '<string>',
    venueName: '<string>',
    address: '<string>',
    location: {},
    spaceId: '<string>',
    visibility: '<string>',
    capacity: 123,
    allowMaybe: true,
    guestListVisible: true,
    hostIds: ['<string>'],
    metadata: {},
    userId: '<string>',
    'cover.options': '<string>',
    gallery: [null],
    'gallery.options': '<string>'
  })
};

fetch('https://api.sublay.io/api/v6/:projectId/api/v7/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sublay.io/api/v6/:projectId/api/v7/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'startTime' => '<string>',
    'type' => '<string>',
    'description' => '<string>',
    'endTime' => '<string>',
    'timezone' => '<string>',
    'url' => '<string>',
    'venueName' => '<string>',
    'address' => '<string>',
    'location' => [
        
    ],
    'spaceId' => '<string>',
    'visibility' => '<string>',
    'capacity' => 123,
    'allowMaybe' => true,
    'guestListVisible' => true,
    'hostIds' => [
        '<string>'
    ],
    'metadata' => [
        
    ],
    'userId' => '<string>',
    'cover.options' => '<string>',
    'gallery' => [
        null
    ],
    'gallery.options' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sublay.io/api/v6/:projectId/api/v7/events"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"startTime\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"endTime\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"url\": \"<string>\",\n  \"venueName\": \"<string>\",\n  \"address\": \"<string>\",\n  \"location\": {},\n  \"spaceId\": \"<string>\",\n  \"visibility\": \"<string>\",\n  \"capacity\": 123,\n  \"allowMaybe\": true,\n  \"guestListVisible\": true,\n  \"hostIds\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"userId\": \"<string>\",\n  \"cover.options\": \"<string>\",\n  \"gallery\": [\n    null\n  ],\n  \"gallery.options\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sublay.io/api/v6/:projectId/api/v7/events")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"startTime\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"endTime\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"url\": \"<string>\",\n  \"venueName\": \"<string>\",\n  \"address\": \"<string>\",\n  \"location\": {},\n  \"spaceId\": \"<string>\",\n  \"visibility\": \"<string>\",\n  \"capacity\": 123,\n  \"allowMaybe\": true,\n  \"guestListVisible\": true,\n  \"hostIds\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"userId\": \"<string>\",\n  \"cover.options\": \"<string>\",\n  \"gallery\": [\n    null\n  ],\n  \"gallery.options\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sublay.io/api/v6/:projectId/api/v7/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"startTime\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"endTime\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"url\": \"<string>\",\n  \"venueName\": \"<string>\",\n  \"address\": \"<string>\",\n  \"location\": {},\n  \"spaceId\": \"<string>\",\n  \"visibility\": \"<string>\",\n  \"capacity\": 123,\n  \"allowMaybe\": true,\n  \"guestListVisible\": true,\n  \"hostIds\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"userId\": \"<string>\",\n  \"cover.options\": \"<string>\",\n  \"gallery\": [\n    null\n  ],\n  \"gallery.options\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

Creates an event. The authenticated user becomes the creator (userId) and is automatically added to hostIds. Supports inline cover and gallery image upload via multipart/form-data. The required location fields depend on type: online needs a url; physical needs an address or location; hybrid needs both a url and an address/location. Requires authentication. Space-scoped events (spaceId) require the spaces bundle and active membership of the space. Image upload requires the files-images bundle.

Body Parameters

string

required

Event title. 1–300 characters.

string

required

ISO datetime when the event starts. RSVPs close at this moment.

string

required

"online", "physical", or "hybrid". Controls which location fields are required.

string

Optional description.

string

Optional ISO datetime when the event ends.

string

Optional IANA timezone string, e.g. "America/New_York".

string

Join/stream URL. Required for online and hybrid events.

string

Optional venue name.

string

Street address. Required (alone or with location) for physical and hybrid events.

{ latitude: number; longitude: number }

Geographic coordinates. Stored as a GeoJSON point and used for proximity search. On multipart requests, send as a JSON string.

string

Optional UUID of a space to scope the event to. Requires the spaces bundle and active membership. Mandatory when visibility is "members".

string

"public", "members", or "invite". Defaults to "public". "members" requires a spaceId.

number

Maximum number of going RSVPs. Positive integer. Omit for unlimited.

boolean

Whether a "maybe" RSVP is allowed. Defaults to true.

boolean

Whether non-hosts can view the named guest list. Defaults to true.

string[]

Additional host user IDs. The creator is always added automatically. On multipart requests, send as a JSON string.

object

Arbitrary key-value data. Up to 1 MB.

string

Service/master key only. Create the event on behalf of this user (who becomes the creator and first host).

file

Optional single cover image. Multipart file field. Requires cover.options when provided.

string

JSON-stringified image-processing options for the cover (the same discriminated union used by Upload Image).

file[]

Optional gallery images (up to 10). Multipart file field. Requires gallery.options when provided.

string

JSON-stringified image-processing options applied to every gallery image.

Response

Returns 201 with the created Event object, including inline rsvpCounts and (with images) the files association.

Error Responses

Invalid Body — 400

{ "error": "Online events require a `url`.", "code": "event/invalid-body" }

files-images Bundle Required — 403

{ "error": "Event cover/gallery images require the files-images bundle. Enable it for this project.", "code": "event/files-images-bundle-required" }

spaces Bundle Required — 403

{ "error": "Space-scoped events require the spaces bundle. Enable it for this project.", "code": "event/spaces-bundle-required" }

Space Not Found — 404

{ "error": "Space not found", "code": "event/space-not-found" }

Not a Space Member — 403

{ "error": "You must be an active member of this space to create an event in it.", "code": "event/not-space-member" }

File Too Large — 413

{ "code": "event/file-too-large", "message": "Image \"cover.jpg\" exceeds 50MB limit." }

Invalid Image — 422

{ "code": "event/invalid-image", "message": "File \"cover.jpg\" is not a valid image: ..." }

See also: useCreateEvent · node-sdk · js-sdk

Overview

Auth Endpoints

OAuth Endpoints

User Endpoints

User Follow Operations

User Connection Operations

Follow Endpoints

Connection Endpoints

Entity Endpoints

Comment Endpoints

Chat — Conversations

Chat — Members

Chat — Messages

Collection Endpoints

App Notification Endpoints

Push Notification Endpoints

Report Endpoints

Search Endpoints

Space Endpoints

Space — Membership

Space — Rules

Space — Moderation

Space — Chat

Event Endpoints

Storage Endpoints

Utils

Crypto

Body Parameters

Response

Error Responses

​Body Parameters

​Response

​Error Responses

Body Parameters

Response

Error Responses