Update Meeting Template

put

https://api.joinpopp.com/v1/meeting-templates/{templateId}

Updates a calendar meeting template by ID.

Nearly every field is required, so in practice a call supplies the template's
whole configuration rather than a patch. The optional fields behave
differently: omitting one leaves the stored value unchanged — it does not
clear it. guestLabel accepts null to clear it explicitly, and
availabilityOutreachSettings is merged field by field, so you can send only
the keys you want to change and the rest are preserved. availabilityMethod
follows the same rule: omit it and the template keeps its current method
instead of reverting to COLLECTIVE, and the participants you send are
validated against whichever method results.

meetingParticipants is the exception, and the sharp edge: the array you
send becomes the template's entire panel, so a participant currently on the
template but missing from your payload is removed from it. There is no
partial update of a single participant.

The intended flow is read-modify-write. Call
Get Meeting Template, change what you need,
and send the whole thing back. Every field this endpoint requires is returned
by that read except isCalendarConnected, which you supply per participant.
openHours is returned alongside availability in exactly the shape this
endpoint expects, and videoConferencingProvider comes back for templates
that use video conferencing.

Returns 404 if the template does not exist, or if it belongs to a different
organization than the one tied to the API key.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

templateId

string

required

The unique identifier of the meeting template

Body Params

The updated meeting template configuration

meetingParticipants

array of objects

required

length ≥ 1

The complete participant panel for the meeting. The array you send becomes the panel, so a participant currently on the template but absent from this list is removed from it. There is no way to update a single participant in isolation — read the template first with Get Meeting Template and send its meetingParticipants back with isCalendarConnected added to each. For a COLLECTIVE meeting exactly one participant must be the 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.

Meeting Participants*

availabilityMethod

string

enum

Determines who must attend the meeting. Optional on update: omitting it leaves the template's current method unchanged rather than resetting it to COLLECTIVE, and the participants you send are validated against that resulting method. 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

required

0 to 120

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

reminderMinutesBeforeMeeting

integer

required

≥ 1

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

noticePeriodMinutes

integer

required

≥ 0

Minimum notice required for booking in minutes.

availableDaysInTheFuture

integer

required

≥ 1

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

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). Send null to clear a custom label and fall back to the default.

availabilityOutreachSettings

object

Template-level settings for availability outreach emails sent to participants with autoCollectAvailability enabled. Per-participant overrides take priority over these values. On update these are merged field by field onto the stored settings — send only the keys you want to change; omitted keys keep their current value, and omitting the object entirely leaves all of them unchanged. See the Scheduling with Availability Collection guide for details.

Responses

200

400

401

404

500