Create Meeting Template

post

https://api.joinpopp.com/v1/meeting-templates

Creates a calendar meeting template for scheduling meetings. The template defines meeting parameters such as duration, participants, availability, and video conferencing settings.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The input to create a meeting template

meetingParticipants

array of objects

required

length ≥ 1

List of participants for the meeting. For a COLLECTIVE meeting (the default) exactly one participant must be marked as organizer; for a round-robin availabilityMethod the pool must contain 2 to 10 participants and no organizer is required. Every participant must be able to supply availability one of three ways: a connected calendar (isCalendarConnected true), pre-defined availability.timeSlots, or autoCollectAvailability. Any combination of the three across the panel is allowed.

Meeting Participants*

availabilityMethod

string

enum

Defaults to COLLECTIVE

Determines who must attend the meeting. COLLECTIVE books a slot that works for every participant on the panel and requires exactly one organizer. ROUND_ROBIN_MAX_AVAILABILITY routes each meeting to a single participant from a pool of 2 to 10, chosen to give the candidate the widest choice of slots, and requires no organizer.

Allowed:

title

string

required

The title of the meeting.

description

string

A description for the meeting that will be included in the calendar invite.

openHours

array of objects

required

length ≥ 1

Available time windows for scheduling the meeting.

Open Hours*

timezone

string

required

IANA timezone string for the meeting.

duration

integer

required

1 to 1440

The duration of the meeting in minutes.

videoConferencing

boolean

required

Whether to include video conferencing for the meeting. If true, videoConferencingProvider is required and location cannot be specified.

videoConferencingProvider

string

enum

The video conferencing provider to use. Required when videoConferencing is true.

Allowed:

location

string

The physical location for the meeting. Cannot be used when videoConferencing is enabled.

buffer

integer

0 to 120

Defaults to 0

Buffer time in minutes before/after meetings. Must be a multiple of 5.

reminderMinutesBeforeMeeting

integer

≥ 1

Defaults to 1440

How many minutes before the meeting to send a reminder notification.

noticePeriodMinutes

integer

≥ 0

Defaults to 0

Minimum notice required for booking in minutes.

availableDaysInTheFuture

integer

≥ 1

Defaults to 30

How far ahead a candidate may book on the booking page, in days. Distinct from availabilityOutreachSettings.periodDays, which controls the window interviewers are asked to offer availability within. Neither field caps the other.

guestLabel

string

length between 1 and 50

Noun used in the availability-outreach email for the counterparty the interviewer is scheduled to meet — the person who books the slot. Applies to the whole meeting. Defaults to "candidate"; override with e.g. "recruiter". Must not begin with "the" (Popp prefixes it automatically).

availabilityOutreachSettings

object

Template-level settings for availability outreach emails sent to participants with autoCollectAvailability enabled. Per-participant overrides take priority over these values. See the Scheduling with Availability Collection guide for details.

Responses

201

400

401

500