Update a calendar

patch

https://api.addevent.com/calevent/v2/calendars/{calendar_id}

Updates a calendar by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts mostly the same properties as the calendar creation call.

Path Params

calendar_id

string

required

Unique identifier for the calendar.

Body Params

title

string

The calendar's title. It must be a non-empty, single-line string.

timezone

string

Defaults to America/Los_Angeles

The default timezone for events created on this calendar. The List timezones endpoint returns all of the timezone values that are supported, or you can use our Timezone Lookup Tool to find a timezone. Defaults to America/Los_Angeles.

weekday_begin

string

enum

Defaults to sunday

The day of the week that the calendar starts on. Values are sunday or monday.

Allowed:

description

string

The calendar's description. This appears on the calendar landing page and can be used to display additional information to users about the calendar. Accepts plain text and simplified HTML.

internal_name

string

An internal name for the calendar which will not be displayed publicly. This can be used internally to distinguish between calendars, to add additional information/context to a calendar, or to store an external ID that relates to another system.

calendar_color

integer

1 to 20

Defaults to 1

The color of the calendar. This appears in the dashboard. Accepts values between 1 and 20 that correspond to the colors on the calendar's palette.

landing_page_template_id

string

Defaults to default

The ID of the custom calendar landing page template to associate with the calendar. Accepts the value default, which uses the standard AddEvent template, or the ID of a custom template, which can be retrieved with the List calendar templates endpoint.

embeddable_calendar_template_id

string

Defaults to default

The ID of the custom embeddable calendar template to associate with the calendar. Accepts the value default, which uses the standard AddEvent template, or the ID of a custom template, which can be retrieved with the List calendar templates endpoint.

custom_data

object

Arbitary key-value pairs that can be attached to a calendar. Useful for storing additional structured data on an object, for example, storing external IDs to link a calendar to another system or linking to custom images for each calendar.

Responses

404

Not found

200Ok

400Bad request