Skip to main content
POST
Create an event

Authorizations

Authorization
string
header
required

Provide your API key secret in the Authorization header

Body

application/json
eventType
enum<string>
required

Event type, in the public taxonomy shared with every /v1 read: EVENT covers both Conference and Virtual event (eventFormat distinguishes them), FIELD_EVENT, WEBINAR, THIRD_PARTY_EVENT. Determines which other fields apply.

Available options:
EVENT,
FIELD_EVENT,
WEBINAR,
THIRD_PARTY_EVENT
title
string
required

Name of the event.

Maximum string length: 400
startDateTime
string<date-time>
required
tz
string
required

IANA timezone of the event, e.g. Asia/Kolkata. Required.

Maximum string length: 50
teamId
string
required

Identifier of the owning team. Required.

Minimum string length: 1
description
string

Description of the event. Required. Rich-text HTML.

Maximum string length: 20000
endDateTime
string<date-time>

End of the event. Required, and must be after startDateTime.

eventFormat
enum<string>

VIRTUAL, IN_PERSON or HYBRID. Applies to EVENT only — it is what separates a Conference from a Virtual event. Set by the server for every other type.

Available options:
VIRTUAL,
IN_PERSON,
HYBRID
addressDetails
object
brandKitId
string

Identifier of a published brand kit to apply.

salesforceCampaignId
string

Salesforce campaign ID to link. Some organizations require it; a 422 says so.

tagNames
string[]

Names of existing organization tags. Maximum 10. Never created implicitly.

Maximum array length: 10

Names of existing organization tags. Maximum 10. Never created implicitly.

languageCodes
string[]

Response

Event created

Result of a successful create. A request that cannot proceed is a 422 ApiErrorResponse instead.

status
enum<string>

NEEDS_INPUT when the request cannot proceed, CREATED when the event exists.

Available options:
NEEDS_INPUT,
CREATED
eventId
string

Identifier of the created event. Present only when status is CREATED.

eventUrl
string

Link to the created event's setup page. Present only when status is CREATED.