API Reference

Update an event in a site

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

This API allows us to update an existing event in a site

Path Params
string
required

The ID of the site containing the event

string
required

The ID of the content/event to update

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 content 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

uuid

UUID of the user who authored the event

date-time

Event start date and time in ISO 8601 UTC format

date-time

Event end date and time in ISO 8601 UTC format

string
enum

Publishing status of the event

Allowed:
string

Event timezone in IANA format (e.g., 'America/Los_Angeles')

string
length ≥ 1

Event location

directions
array of strings
length ≤ 10

Array of direction instructions

directions
string
enum

Layout style for the featured image

Allowed:
listOfOrganizers
array of uuids

Array of organizer UUIDs

listOfOrganizers
string | null

URL to the event location map

string | null

Caption for the featured image

string
length ≤ 255

Title of the event

string

Main content of the event in HTML format

boolean

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

Whether the event is all day

string

Language of the 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