Assign event label

post

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

Assign a check-in label template to an event, or update an existing assignment by its id, scoping which roles, sessions, and groups the label prints for.

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.

Body Params

The details of the label to use.

int32 | null

The id of the event label assignment. On writes, identifies an existing assignment to update; omit to create a new one.

label

object | null

A reference to an existing record by its id.

shared

boolean

For repeating events, whether the label is inherited from the parent event. On writes, set to true to assign the label to every occurrence in the series.

roles

object | null

The check-in roles (family positions) the label prints for. A selection other than "specific" prints for all roles.

sessions

object | null

The check-in sessions the label prints for. A selection other than "specific" prints for all sessions.

groups

object | null

The check-in groups the label prints for. A selection other than "specific" prints for all groups.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200

401

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

404Not Found