Unpublish event

POST 
/events/:id/unpublish

Unpublish event

Request

Path Parameters

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

Body

Example (auto)

{}

200

Unpublishes the 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: unpublishes_the_event_and_returns_200

{
  "object": "event",
  "id": "d7971452-a59e-4ec3-a0fa-5e1bb0aae340",
  "slug": "activity-test-event",
  "name": "Activity Test Event",
  "description": "Event used for activity tracking tests",
  "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": "dark",
  "seatsEventKey": null,
  "likeCount": 0,
  "url": "http://www.viewcy.com/event/activity-test-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

Unpublishes the event

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example (auto)

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

404

Unpublishes the 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 the event has sold tickets

objectstringrequired

statusintegerrequired

messagestringrequired

errorsobject[]required

messagestring

metaobjectrequired

requestIdstringrequired

Example: returns_422_when_the_event_is_already_a_draft

{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "message": "Event is already a draft"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

Example: returns_422_when_the_event_has_sold_tickets

{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "message": "You cannot unpublish this event because it has sold tickets. Please contact Viewcy support for assistance."
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}