Skip to main content

This page is also available as plain markdown · OpenAPI spec

Publish event

POST 
/events/:id/publish

Publish event

Request​

Path Parameters

    idstringrequired
    Example: 00000000-0000-0000-0000-000000000000

Body

Example (auto)
{}

200

Publishes the draft event
objectstringrequired
idstringrequired
slugstringrequired
namestringrequired
descriptionstringrequired
categorystringrequired
statusstringrequired
visibilitystringrequired
accessModestringrequired
timezonestringrequired
locationSettingstringrequired
hideAddressUntilPurchasebooleanrequired
featuredVideoUrlnullablerequired
bookTextstringrequired
collectInformationSettingstringrequired
refundsAllowedbooleanrequired
orderAnswersEditablebooleanrequired
doorTimeMinutesnullablerequired
showOccurrencesAsSeparateEventsbooleanrequired
tagsundefined[]required
registrationLimitintegerrequired
currencystringrequired
featuredImageUrlnullablerequired
imagesundefined[]required
themestringrequired
seatsEventKeynullablerequired
likeCountintegerrequired
urlstringrequired
createdAtstringrequired
updatedAtstringrequired
metaobjectrequired
requestIdstringrequired
Example: publishes_the_draft_event_and_returns_200
{
  "object": "event",
  "id": "062a5e0a-bbea-4836-bfda-12407804b88f",
  "slug": "draft-event",
  "name": "Draft Event",
  "description": "An unpublished draft event",
  "category": "Events",
  "status": "published",
  "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": "dark",
  "seatsEventKey": null,
  "likeCount": 0,
  "url": "http://www.viewcy.com/event/draft-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

Publishes the draft event
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example (auto)
{
  "object": "string",
  "status": 0,
  "message": "string",
  "meta": {
    "requestId": "string"
  }
}

404

Publishes the draft event
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_404_when_the_event_does_not_exist
{
  "object": "error",
  "status": 404,
  "message": "Resource not found",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

422

Returns 422 when every occurrence is canceled
objectstringrequired
statusintegerrequired
messagestringrequired
errorsobject[]required
messagestring
fieldstring
metaobjectrequired
requestIdstringrequired
Example: returns_422_when_the_event_is_already_published
{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "message": "Event is already published"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: returns_422_when_the_event_has_no_scheduled_occurrences
{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "field": "events",
      "message": "can't be blank"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: returns_422_when_the_event_is_canceled_(does_not_revive_it)
{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "message": "Event is canceled and cannot be published"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: returns_422_when_every_occurrence_is_canceled
{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "message": "Event has no active occurrences to publish"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}