Create event

post

https://{tenant}.onechurchsoftware.com/api/events

Create a new event. Unless allDay is true, at least one time slot must be provided in times. Provide one or more schedules to create a repeating event; its occurrences are generated automatically. Returns the new event's id and name.

Required permission: Full Write Events

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The event to create.

name

string | null

required

The name of the event.

start

date-time | null

required

When the event starts (UTC). When the event has time slots, this is the start of the earliest one.

fields

array of objects | null

Custom fields for this object

fields

description

string | null

The full HTML description of the event.

end

date-time | null

When the event ends (UTC).

allDay

boolean | null

Whether the event runs all day rather than at specific times.

schedules

array of objects | null

The repeating schedule definitions for the event.

schedules

group

object | null

The group the event belongs to, when the event is on a group's calendar. On writes, only the group's id is used.

groupPrimary

boolean | null

Whether this event is the group's primary linked event. Null when the event is not linked to a group.

times

array of objects | null

The time slots for the event (UTC).

times

categories

public

boolean

Whether the event is visible to the public (inherited from its calendar).

campuses

array of objects | null

The campuses the event is associated with. On writes, only each campus's id is used; values come from /api/locations.

campuses

address

object | null

The street address where the event takes place.

settings

object | null

Sign-up, registration, and check-in settings for the event. Event search results populate only the registration, attendance, and form fields.

merchant

object | null

The merchant account used for paid registrations. Only returned to authenticated callers. On writes, only the merchant account's id is used.

calendar

object | null

The calendar the event belongs to. The event endpoints populate the id, code, name, color, and flags; the remaining statistics fields come from the calendars endpoints. On writes, provide the calendar's id or code (required unless the event belongs to a group); values come from /api/calendars.

listed

boolean | null

Whether the event appears in public listings.

exceptions

object | null

For repeating events, dates added to or removed from the generated schedule (UTC).

action

string | null

For repeating events, which occurrences an edit applies to: all, future, or single. Defaults to only the event being edited.

changeSchedule

boolean | null

Set to true when an edit changes the repeating schedules; otherwise the existing recurrence is kept.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK

404Not Found