Add an event to a site

post

https://{endpoint}/v1/b2b/content/sites/{siteId}/event

This API allows us to add an event to a site

Path Params

siteId

string

required

The ID of the site to add an event to

Query Params

action

string

enum

required

The action to perform on the event

Allowed:

Body Params

listOfFiles

array of objects

Array of file attachments

listOfFiles

publishAt

date-time

Date and time when the event should be published (required when publishingStatus is 'schedule'). Must be in ISO 8601 UTC format

publishTo

date-time | null

Date and time when the content should expire/unpublish. Must be in ISO 8601 UTC format

startsAt

date-time

required

Event start date and time in ISO 8601 format

endsAt

date-time

required

Event end date and time in ISO 8601 format

bodyHtml

string

required

Main content of the event in HTML format

publishingStatus

string

enum

required

Publishing status of the event

Allowed:

timezoneIso

string

required

Timezone ISO string for the event

location

string

required

length ≥ 1

Event location

directions

array of strings

length ≤ 10

Array of directions to the event location

directions

imgLayout

string

enum

Layout style for the featured image

Allowed:

listOfOrganizers

array of uuids

Array of organizer user IDs

listOfOrganizers

mapURL

string | null

URL to map for the event location

imgCaption

string | null

Caption for the featured image

title

string

required

length ≤ 255

Title of the event

isFeedEnabled

boolean

required

Whether the event appears in feeds

isRestricted

boolean

Whether the content is restricted to specific audiences

targetAudience

array of uuids

List of UUIDs identifying the target audiences

targetAudience

isQuestionAnswerEnabled

boolean

Whether question and answer feature is enabled

listOfTopics

array of objects | null

Array of topics associated with the event

listOfTopics

summary

string | null

Summary of the event content

imgLandscapeFile

uuid | null

UUID of the landscape image file

imgFile

uuid | null

UUID of the main image file

imgOriginalFile

uuid | null

UUID of the original image file

rsvp

object

RSVP configuration for the event

isAllDay

boolean

required

Whether the event is an all-day event

language

string

Language of the event content

createdBy

uuid

required

UUID of the user creating the event

Responses

200Success

400Error

401Authorize error

403Forbidden error