loading

Events (Legacy): List

Retrieve all Event Lists for an account.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

limit
integer <= 50
Default: 10

Number of results to return.

offset
integer
Default: 0

Number of results to skip. Used to page through results. Cannot be used together with pageToken.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Events (Legacy): Create

Create a new Event List.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/kjson
id
string <= 32 characters

List ID.

name
string

List name.

title
string

List title that appears on listings.

publish
boolean

Indicates whether the List should be shown on your listings.

language
string

List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language.

Examples: en, en_GB, fr_CA

Array of objects

A list of sections. However, Calendars cannot have more than one section.

Responses

Request samples

Content type
application/kjson
{
  • "id": "string",
  • "name": "string",
  • "title": "string",
  • "publish": true,
  • "language": "string",
  • "sections": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Events (Legacy): Get

Retrieve a specific Event List.

path Parameters
accountId
required
string
listId
required
string

ID of this List.

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Events (Legacy): Update

Update an existing Event List.

path Parameters
accountId
required
string
listId
required
string

ID of this List.

query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/kjson
id
string <= 32 characters

List ID.

name
string

List name.

title
string

List title that appears on listings.

publish
boolean

Indicates whether the List should be shown on your listings.

language
string

List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language.

Examples: en, en_GB, fr_CA

Array of objects

A list of sections. However, Calendars cannot have more than one section.

Responses

Request samples

Content type
application/kjson
{
  • "id": "string",
  • "name": "string",
  • "title": "string",
  • "publish": true,
  • "language": "string",
  • "sections": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Events (Legacy): Delete

Delete an existing Event List.

path Parameters
accountId
required
string
listId
required
string

ID of this List.

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": { }
}