Toggle attendance in bulk

post

https://{tenant}.onechurchsoftware.com/api/events/{id}/attendance/toggle/bulk

Mark guests present or absent on the event's attendance report in bulk. The query filters select guests the same way as event attendance; ids narrows the selection further using the composite row ids returned there.

Required permission: Full Write Events

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the event.

Query Params

view

string

Filter for the data returned. If not provided, everyone on the guest list is returned. Acceptable values are: present (only present), absent (only absent), groups (only group attendees), noguest (only not on guest list), entries (only form entries), profiles (only profiles added), external (only external added), checkin (has checked in), checkout (has checked out), nocheckin (did not check in).

letter

string

Comma-delimited list of letters. Returns people whose last name begins with one of the given letters.

source

string

Comma-delimited list of source ids describing why someone is on the guest list. Accepted values are: 1 = Group, 2 = External (Added), 3 = Profile (Added), 4 = Form Entry, 5 = Not On Guest List, 6 = Check-in Session.

type

string

Comma-delimited list of record type ids. Use -1 to include people without a record type. Values come from /api/property_values/person_record_type/values.

position

string

Comma-delimited list of family position ids. Values come from /api/property_values/household_roles/values.

campus

string

Comma-delimited list of campus ids. Use -1 to include people without a campus. Values come from /api/locations.

age.start

double

Include people of this age or older.

age.end

double

Include people of this age or younger.

firstTime

boolean

Whether to return only first-time guests (true) or only returning guests (false).

filter

string

If set, searches for people which match the given search term. Fields considered are the first name, last name, and nickname.

Body Params

The details on who to mark attendance for.

ids

array of strings | null

Composite row ids from event attendance (e.g. P123) selecting which guests to toggle. Omit to toggle every guest matching the query filters.

ids

include

boolean | null

Whether ids is an include list (true) or an exclude list (false).

present

boolean | null

True to mark present, false to mark absent. Defaults to false. Marking a guest absent removes their attendance row and any check-in logs.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

204

No Content

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

404Not Found