Updating Events using API v3 Owner Mode

Early Access

This functionality is available under early access. Its behavior or response format may change before general availability and it may require additional configuration by the Spektrix team to access it. Contact us if you plan to use it in a production integration.

This endpoint complements Creating Events using API v3 Owner Mode. Use it to update an Event. Event Instances, including their dates, seating plans, and prices, are created and updated separately.

Authentication

This endpoint is available only to integrations authenticated in API v3 System Owner mode. For more detail on signing requests, see Authentication.

Request

PATCH /api/v3/events/{id}

PATCH /api/v3/events/{id}
Content-Type: application/json

Example request

{
  "name": "Macbeth - Extended Run",
  "duration": 180,
  "description": "A new extended production of Macbeth.",
  "Attribute_Genre": "Comedy"
}

Replace any Attribute_* properties with Event attributes configured in your system.

Partial updates

PATCH applies only the properties present in the JSON body:

• A property that is present is applied, even if its value is the same as the current value.
• A property that is absent is left untouched.
• There are no required properties. An empty JSON object {} is valid and changes nothing.
• A request with no JSON body returns 400 Bad Request with the message request body is required.

Updatable properties

Property	Description
name	Name of the Event. If supplied, it must not be empty.
duration	Duration in minutes.
description	Plain-text Event description.
wikiText	Formatted description in Spektrix wiki-text format.
webEventId	Web-facing identifier. Maximum 20 characters.
Attribute_*	Values for configured Event attributes.

Event attributes

Attributes are patched in the same way as they are supplied to POST: use the attribute name as the JSON property name and provide the value.

{
  "Attribute_Genre": "Comedy"
}

When patching attributes:

• Supplied attributes are merged over the Event's existing attributes. Attributes you do not mention are unchanged.
• Supplying an empty string clears an attribute's value.
• Attribute names containing spaces are supported, for example Attribute_Special Performance.
• If no attributes are supplied, the Event's attributes are not changed.

Successful response

A successful patch returns 200 OK. The response body contains the updated API v3 Event resource in the same format as GET /api/v3/events/{id}.

Error responses

Status	Meaning
400 Bad Request	The request body is missing, a property is unrecognized, name is supplied but empty, or webEventId exceeds 20 characters.
404 Not Found	The Event id in the route could not be found.
401 Unauthorized	The credentials do not permit use of this System Owner mode endpoint.

Nothing is saved when a request fails. Validation happens before the change is committed, so a rejected patch leaves the Event exactly as it was.

Suggested early-access test scenarios

Begin with a simple, known-good configuration:

1. Create an Event, or identify an existing Event, and retrieve it with GET /api/v3/events/{id}.
2. Patch a single value, such as duration or webEventId, and retrieve the Event again.
3. Patch one attribute and confirm the other attributes are untouched.
4. Clear an attribute by supplying an empty string.
5. Try an empty name.
6. Try a webEventId longer than 20 characters.
7. Try an unknown Event id.
8. Confirm that the Event's Event Instances are unaffected by the patch.