Events

Update special event

Update the details of a special event.

patch/special-events/{eventId}

Request

Base URL
https://api.fake-museum-example.com/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/redocly/apis/redocly-museum/docs/special-events/:eventId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

eventIdstring uuid required

Example:dad4bce8-f5cb-4078-a211-995864315e39

Identifier for a special event.

Request body

namestring

Name of the special event.

locationstring

Location where the special event is held.

eventDescriptionstring

Description of the special event.

datesDate[]

List of planned dates for the special event.

pricenumber float

Price of a ticket for the special event.

Example request

{
  "name": "Pirate Coding Workshop",
  "location": "Computer Room",
  "eventDescription": "Captain Blackbeard shares his love of the C...language. And possibly Arrrrr (R lang).",
  "dates": [
    "2023-10-29"
  ],
  "price": 25
}

Response

Success.

eventIdstring uuid required

Identifier for a special event.

namestring required

Name of the special event.

locationstring required

Location where the special event is held.

eventDescriptionstring required

Description of the special event.

datesDate[] required

List of planned dates for the special event.

pricenumber float required

Price of a ticket for the special event.

Example response

{
  "eventId": "3be6453c-03eb-4357-ae5a-984a0e574a54",
  "name": "Pirate Coding Workshop",
  "location": "Computer Room",
  "eventDescription": "Captain Blackbeard shares his love of the C...language. And possibly Arrrrr (R lang).",
  "dates": [
    "2023-10-29"
  ],
  "price": 25
}

Changes

No recorded changes to this operation across all 2 revisions of this API.