Create event

POST 
/events

Create event

Request

Body

namestringrequired

categorystringrequired

descriptionstring

timezonestring

registrationLimitinteger

bookTextstring

tagsstring[]

locationobject

namestringrequired

addressstringrequired

citystringrequired

countrystringrequired

statestringrequired

zipcodestringrequired

occurrencesobject[]

startsAtstring

endsAtstring

collectInformationSettingstring

refundsAllowedboolean

orderAnswersEditableboolean

slugstring

doorTimeMinutesinteger

showOccurrencesAsSeparateEventsboolean

guestEmailMessagestring

donorEmailMessagestring

imageIdsstring[]

featuredImageIdstring

Example (auto)

{
  "name": "string",
  "category": "string",
  "description": "string",
  "timezone": "string",
  "registrationLimit": 0,
  "bookText": "string",
  "tags": [
    "string"
  ],
  "location": {
    "name": "string",
    "address": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "zipcode": "string"
  },
  "occurrences": [
    {
      "startsAt": "string",
      "endsAt": "string"
    }
  ],
  "collectInformationSetting": "string",
  "refundsAllowed": true,
  "orderAnswersEditable": true,
  "slug": "string",
  "doorTimeMinutes": 0,
  "showOccurrencesAsSeparateEvents": true,
  "guestEmailMessage": "string",
  "donorEmailMessage": "string",
  "imageIds": [
    "string"
  ],
  "featuredImageId": "string"
}

201

Creates a draft event

objectstringrequired

idstringrequired

slugstringrequired

namestringrequired

descriptionstringnullablerequired

categorystringrequired

statusstringrequired

visibilitystringrequired

accessModestringrequired

timezonestringrequired

locationSettingstringrequired

hideAddressUntilPurchasebooleanrequired

featuredVideoUrlnullablerequired

bookTextstringrequired

collectInformationSettingstringrequired

refundsAllowedbooleanrequired

orderAnswersEditablebooleanrequired

doorTimeMinutesintegernullablerequired

showOccurrencesAsSeparateEventsbooleanrequired

tagsstring[]required

registrationLimitintegerrequired

currencystringrequired

featuredImageUrlstringnullablerequired

imagesstring[]required

themestringrequired

seatsEventKeynullablerequired

likeCountintegerrequired

urlstringrequired

createdAtstringrequired

updatedAtstringrequired

metaobjectrequired

requestIdstringrequired

Example: creates_a_draft_event_with_a_minimal_body

{
  "object": "event",
  "id": "00000000-0000-4000-8000-000000000005",
  "slug": "my_api_event",
  "name": "My API Event",
  "description": null,
  "category": "Events",
  "status": "draft",
  "visibility": "listed",
  "accessMode": "open",
  "timezone": "America/New_York",
  "locationSetting": "physical",
  "hideAddressUntilPurchase": false,
  "featuredVideoUrl": null,
  "bookText": "Get tickets",
  "collectInformationSetting": "only-buyer",
  "refundsAllowed": false,
  "orderAnswersEditable": false,
  "doorTimeMinutes": null,
  "showOccurrencesAsSeparateEvents": false,
  "tags": [],
  "registrationLimit": 0,
  "currency": "usd",
  "featuredImageUrl": null,
  "images": [],
  "theme": "light",
  "seatsEventKey": null,
  "likeCount": 0,
  "url": "http://www.viewcy.com/event/my_api_event",
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

Example: creates_an_event_with_description,_tags,_location,_and_occurrences

{
  "object": "event",
  "id": "00000000-0000-4000-8000-000000000005",
  "slug": "full_api_event",
  "name": "Full API Event",
  "description": "A fully populated event created via the public API.",
  "category": "Events",
  "status": "draft",
  "visibility": "listed",
  "accessMode": "open",
  "timezone": "America/New_York",
  "locationSetting": "physical",
  "hideAddressUntilPurchase": false,
  "featuredVideoUrl": null,
  "bookText": "Reserve",
  "collectInformationSetting": "only-buyer",
  "refundsAllowed": false,
  "orderAnswersEditable": false,
  "doorTimeMinutes": null,
  "showOccurrencesAsSeparateEvents": false,
  "tags": [
    "jazz",
    "improv"
  ],
  "registrationLimit": 50,
  "currency": "usd",
  "featuredImageUrl": null,
  "images": [],
  "theme": "light",
  "seatsEventKey": null,
  "likeCount": 0,
  "url": "http://www.viewcy.com/event/full_api_event",
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

401

Returns 401

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_401

{
  "object": "error",
  "status": 401,
  "message": "Authentication required",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

403

Creates a draft event

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example (auto)

{
  "object": "string",
  "status": 0,
  "message": "string",
  "meta": {
    "requestId": "string"
  }
}

422

Creates a draft event

objectstringrequired

statusintegerrequired

messagestringrequired

errorsobject[]required

fieldstring

messagestring

metaobjectrequired

requestIdstringrequired

Example: returns_422_when_an_occurrence_timestamp_has_no_timezone_offset

{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "field": "occurrences",
      "message": "[0] startsAt must include a timezone offset (e.g. \"2026-06-01T19:00:00Z\")"
    },
    {
      "field": "occurrences",
      "message": "[0] endsAt must include a timezone offset (e.g. \"2026-06-01T19:00:00Z\")"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

Example: returns_422_with_field_errors_when_required_fields_are_missing

{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "field": "category",
      "message": "can't be blank"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}