POST
/
cms
/
events
/
v1

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
project_id
string
required
type_id
string

The type id of the event. For example football_match. May be set to default when no custom fields are present.

title
string
description
string
status
enum<string>

Current status of the event

Available options:
EVENT_STATUS_UNSPECIFIED,
EVENT_STATUS_SCHEDULED,
EVENT_STATUS_RESCHEDULED,
EVENT_STATUS_CANCELLED,
EVENT_STATUS_POSTPONED,
EVENT_STATUS_MOVED_ONLINE,
EVENT_STATUS_DELAYED,
EVENT_STATUS_STARTED,
EVENT_STATUS_PAUSED,
EVENT_STATUS_SUSPENDED,
EVENT_STATUS_FINISHED,
EVENT_STATUS_PRESCHEDULED
start_time
string
online_url
string
physical_location
object
thumbnail_asset_id
string
poster_asset_id
string
video_ids
string[]
fields
object
visibility
enum<string>
Available options:
VISIBILITY_UNSPECIFIED,
VISIBILITY_PUBLISHED,
VISIBILITY_UNLISTED,
VISIBILITY_HIDDEN
localized_title
object

A map of localized titles for this event, for end users to see. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the title field.

localized_description
object

A map of localized descriptions for this event. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the description field.

localized_thumbnail_asset_id
object

A map of localized thumbnail asset IDs for this event. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the thumbnail_asset_id field.

localized_poster_asset_id
object

A map of localized poster asset IDs for this event. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the poster_asset_id field.

Response

200 - application/json
event
object

An event happening at a certain time and location, such as a sports game, concert, lecture, or festival.

List eventsDuplicate event