Update event

PATCH /events/:id

Update event

Request

Path Parameters

idstringrequired

Example: 00000000-0000-0000-0000-000000000000

Body

namestring

visibilitystring

registrationLimitinteger

doorTimeMinutesinteger

tagsstring[]

timezonestring

featuredImageIdstring

imageIdsstring[]

slugstring

Example (auto)

{
  "name": "string",
  "visibility": "string",
  "registrationLimit": 0,
  "doorTimeMinutes": 0,
  "tags": [
    "string"
  ],
  "timezone": "string",
  "featuredImageId": "string",
  "imageIds": [
    "string"
  ],
  "slug": "string"
}

200

Updates the event slug

objectstringrequired

idstringrequired

slugstringrequired

namestringrequired

descriptionstringrequired

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: updates_only_the_sent_fields

{
  "object": "event",
  "id": "062a5e0a-bbea-4836-bfda-12407804b88f",
  "slug": "draft-event",
  "name": "Renamed Event",
  "description": "An unpublished draft event",
  "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/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"
  }
}

Example: updates_multiple_fields_in_one_request

{
  "object": "event",
  "id": "062a5e0a-bbea-4836-bfda-12407804b88f",
  "slug": "draft-event",
  "name": "Draft Event",
  "description": "An unpublished draft event",
  "category": "Events",
  "status": "draft",
  "visibility": "unlisted",
  "accessMode": "open",
  "timezone": "America/New_York",
  "locationSetting": "physical",
  "hideAddressUntilPurchase": false,
  "featuredVideoUrl": null,
  "bookText": "Get tickets",
  "collectInformationSetting": "only-buyer",
  "refundsAllowed": false,
  "orderAnswersEditable": false,
  "doorTimeMinutes": 30,
  "showOccurrencesAsSeparateEvents": false,
  "tags": [
    "jazz",
    "improv"
  ],
  "registrationLimit": 25,
  "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"
  }
}

Example: updates_the_timezone_from_an_iana_identifier

{
  "object": "event",
  "id": "062a5e0a-bbea-4836-bfda-12407804b88f",
  "slug": "draft-event",
  "name": "Draft Event",
  "description": "An unpublished draft event",
  "category": "Events",
  "status": "draft",
  "visibility": "listed",
  "accessMode": "open",
  "timezone": "America/Chicago",
  "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

Updates a draft event

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example (auto)

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

404

Returns 404 when event is not owned by the caller

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_404_when_event_is_not_owned_by_the_caller

{
  "object": "error",
  "status": 404,
  "message": "Resource not found",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

422

Rejects the occurrences key

objectstringrequired

statusintegerrequired

messagestringrequired

errorsobject[]required

fieldstring

messagestring

metaobjectrequired

requestIdstringrequired

Example: returns_422_when_timezone_is_not_a_valid_iana_identifier

{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "field": "timezone",
      "message": "is not a valid IANA timezone"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

Example: returns_422_when_registrationlimit_is_negative

{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "field": "registrationLimit",
      "message": "must be greater than or equal to 0"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

Example: returns_422_when_category_is_not_a_valid_category_name

{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "field": "category",
      "message": "is not a valid category"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

Update event

/events/:id

Request​

Path Parameters

Body

200

401

403

404

422

Request