CalendarEventCategories
Update CalendarEventCategory
Update an existing CalendarEventCategory record.
PUT
Update CalendarEventCategory
Updates an existing CalendarEventCategory record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CalendarEventCategory-Edit role.Request Body
Required Fields
integer
required
The Id of the CalendarEventCategory record to update.
integer
required
ID of the location that owns this event category; the Admin Tool normally supplies it from the current location context.
string
required
Nonempty name of this event category, used to group related events.
Optional Fields
integer[]
List of CalendarEvent IDs assigned to this category; when supplied on update, it replaces all current assignments, and an empty list removes every assigned event.
integer[]
IDs added to the CalendarEvents relationship..
integer[]
IDs removed from the CalendarEvents relationship..
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the update.
object
Contains the
Id of the updated record.boolean
true if the calendareventcategory was updated successfully.array
null on success.Example Response
400
string
A summary of the validation error(s), in the format
PropertyName: error message.any
null on validation failure.object[]
Array of validation errors.
boolean
false when the request fails validation.Example Response