API Reference

Add an event to a site

post
https://platform.{env}.simpplr.com/v1/content/sites//event

This API allows us to add an event to a site

Path Params
string
required

The ID of the site to add an event to

Query Params
string
enum
required

The action to perform on the event

Allowed:
Body Params
listOfFiles
array of objects

Array of file attachments

listOfFiles
date-time

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

date-time | null

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

date-time
required

Event start date and time in ISO 8601 format

date-time
required

Event end date and time in ISO 8601 format

string
required

Main content of the event in HTML format

string
enum
required

Publishing status of the event

Allowed:
string
required

Timezone ISO string for the event

string
required
length ≥ 1

Event location

directions
array of strings
length ≤ 10

Array of directions to the event location

directions
string
enum

Layout style for the featured image

Allowed:
listOfOrganizers
array of uuids

Array of organizer user IDs

listOfOrganizers
string | null

URL to map for the event location

string | null

Caption for the featured image

string
required
length ≤ 255

Title of the event

boolean
required

Whether the event appears in feeds

boolean

Whether the content is restricted to specific audiences

targetAudience
array of uuids
length ≥ 0

List of UUIDs identifying the target audiences

targetAudience
boolean

Whether question and answer feature is enabled

listOfTopics
array of objects | null

Array of topics associated with the event

listOfTopics
string | null

Summary of the event content

uuid | null

UUID of the landscape image file

uuid | null

UUID of the main image file

uuid | null

UUID of the original image file

rsvp
object

RSVP configuration for the event

boolean
required

Whether the event is an all-day event

string

Language of the event content

Responses

Updated 4 months ago

Language
Credentials
OAuth2
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago