API reference

Public API v1

Deutsch · English · Download OpenAPI · Install browser tracking

API and webhooks are available to all beta workspaces. Operators can disable access per workspace. After beta, access is planned for the Pro plan.

Send Authorization: Bearer <API-Key>. Create keys under Developer; the secret is shown only on creation. Key management requires an owner/admin session; cookie mutations also require Origin, X-CSRF-Token and X-Workspace-Id.

Every mutation requires an Idempotency-Key. Retry an uncertain result using the same key and payload. A different payload returns 409 idempotency_conflict.

Limits apply per key and workspace. On 429, honor Retry-After; RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset describe the checked budget. Errors contain error.code and request_id.

Lists use limit/offset pagination. updated_since is an inclusive instant with an explicit offset; deduplicate overlapping requests by lead_id or booking_id. Lead lists also support status and funnelId. The lead delta includes lead/capture changes and creation of related bookings; later rescheduling or cancellation belongs to the booking delta. GET /v1/bookings with updated_since is beta, with no stability guarantee.

The v1 guarantee covers slots, creating/rescheduling/cancelling bookings, creating/reading leads and reading funnels. Other available operations are beta. Webhook management and delivery history are part of the stable v1 API; use read:webhooks or write:webhooks.

Browser tracking: form_started (omitted for headless), lead_captured and booking_confirmed are invariant embed/UI events in window.dataLayer. Only event, funnel_id, mode, language, lead_id, booking_id; no contact details, answers or hashes. Events wait for analytics_storage OR ad_storage in Consent Mode v2 or setTrackingConsent(true) on the loaded embed; false permanently discards waiting events and events arising during refusal. Use tracking-consent="callback" explicitly for Framer Cookie Banner and Borlabs, restoring saved choices after reload; vendor recipes: /docs?lang=en#tracking. tracking-consent="callback" ignores Consent Mode commands and uses actual banner callbacks only. Tracking state stays in memory until the first grant. tracking-consent="host" explicitly delegates tag consent to the host's GTM; its own deduplication markers may then persist across reload. GTM trigger: Custom Event regex ^(form_started|lead_captured|booking_confirmed)$. Retry/reload are deduplicated by lead/booking ID in the same browser session; without session storage, only in the document. Framer srcdoc uses the verified same-origin parent context and its consent. Hosted pages load no per-funnel tag IDs; without host code/consent integration their events remain gated in memory in M4. Custom API UI must preserve the same invariants.

Install browser tracking

Events and payload

Events are invariant: never remove, rename or duplicate them with extra pushes. form_started follows the first actual field edit per form operation and is omitted for headless. lead_captured follows an acknowledged capture or validated prefill; when created together it precedes booking_confirmed. booking_confirmed follows a successful booking response, including pending invitee confirmation. Only the six shown fields are allowed; unknown IDs are null. Never add contact details, answers, hashes, tokens, URLs or attribution. Custom API UI preserves the same contract.

{
  event: 'booking_confirmed',
  funnel_id: 'fn_example',
  mode: 'calendar_first', // form_first | calendar_first | headless
  language: 'de',         // de | en
  lead_id: 'ld_example',
  booking_id: 'bk_example'
}

Callback mode and saved choices

Explicitly use tracking-consent="callback" for Framer Cookie Banner and Borlabs. Also use it for CookieYes/Complianz variants sending update denied on every visit before a decision, and for pure GTM CMP templates. This mode ignores Consent Mode commands. Actual analytics or advertising approval supplies true; decided refusal of both supplies false; an undecided visitor causes no call. Refusal discards queued events and events arising during refusal. Restore saved choices after CMP readiness and every embed remount; pass false on withdrawal. Register hooks before CMP startup. Set the attribute before the first connection of the element. Without a callback the embed remains gated. For a native embed:

<booking-embed src="https://book.example.invalid/coach/intro"
  tracking-consent="callback"></booking-embed>
<script>
async function onActualBannerDecision(choice) {
  if (typeof choice !== 'boolean') return;
  await customElements.whenDefined('booking-embed');
  document.querySelector('booking-embed')?.setTrackingConsent?.(choice);
}
</script>

CookieYes

For the web app or connected WordPress plugin, read after cookieyes_banner_load and cookieyes_consent_update. isUserActionCompleted distinguishes an actual decision from a first visit. The unconnected WordPress plugin does not support these events.

function syncCookieYes() {
  const consent = window.getCkyConsent?.();
  if (consent?.isUserActionCompleted === true)
    onActualBannerDecision(consent.categories.analytics === true ||
      consent.categories.advertisement === true);
}
document.addEventListener('cookieyes_banner_load', syncCookieYes);
document.addEventListener('cookieyes_consent_update', syncCookieYes);
syncCookieYes();

Vendor documentation

Complianz

Read saved choices after banner readiness and status changes; dismissed proves a decision. Send false on actual withdrawal. Register the equivalent version-specific hooks for older jQuery-based integrations.

function syncComplianz() {
  if (window.cmplz_get_banner_status?.() !== 'dismissed') return;
  onActualBannerDecision(window.cmplz_has_consent('statistics') === true ||
    window.cmplz_has_consent('marketing') === true);
}
document.addEventListener('cmplz_cookie_warning_loaded', syncComplianz);
document.addEventListener('cmplz_status_change', syncComplianz);
document.addEventListener('cmplz_revoke', () => onActualBannerDecision(false));
syncComplianz();

Vendor documentation

Borlabs 3

Set analyticsServiceId and adServiceId to your service IDs. consent-saved reports an actual decision. After after-init restore an existing saved choice. hasSavedBorlabsDecision() in this example is an adapter you must implement, not a Borlabs API: the public v3 API has no universal has-decided getter. hasConsent(...) === false alone may mean a first visit. Use the saved-decision proof from your installed cookie/CMP configuration; without reliable proof, choose a CMP with a documented callback/restore API instead of falling back to gtag defaults.

function readBorlabsDecision() {
  const consents = window.BorlabsCookie?.Consents;
  if (!consents) return;
  onActualBannerDecision(consents.hasConsent(analyticsServiceId) ||
    consents.hasConsent(adServiceId));
}
window.addEventListener('borlabs-cookie-consent-saved', readBorlabsDecision);
window.addEventListener('borlabs-cookie-after-init', () => {
  // Implement using the saved-decision proof of YOUR installed CMP version.
  // false from hasConsent alone does not prove that a visitor decided.
  if (hasSavedBorlabsDecision()) readBorlabsDecision();
});

Vendor documentation

Framer Cookie Banner and srcdoc

The banner needs a GTM container ID for its Consent Mode integration. The general Framer guide documents no universal JS callback. Your GTM adapter must read the actual cookie_consent_update and version-specific proof of a saved decision: undefined = undecided, false = refused, true = analytics or advertising approved. default denied alone proves no decision. Without reliable proof use a CMP with a documented callback/restore API. The child snippet must include tracking-consent="callback" from the start. For srcdoc replace the native onActualBannerDecision with this parent adapter; replace #booking-frame with your fixed frame selector:

let currentChoice; // true | false | undefined; memory only
async function syncFramerEmbed() {
  const frame = document.querySelector('#booking-frame');
  try {
    const child = frame?.contentWindow;
    if (!child || frame.contentDocument?.URL !== 'about:srcdoc') return;
    await child.customElements.whenDefined('booking-embed');
    if (!frame.isConnected || frame.contentWindow !== child) return;
    if (typeof currentChoice === 'boolean')
      child.document.querySelector('booking-embed')?.setTrackingConsent?.(currentChoice);
  } catch { /* Unsupported/cross-origin frames stay gated. */ }
}
function onActualBannerDecision(choice) {
  if (typeof choice !== 'boolean') return;
  currentChoice = choice;
  void syncFramerEmbed();
}
// Bind this listener again to EVERY new frame created by the host.
document.querySelector('#booking-frame')?.addEventListener('load', syncFramerEmbed);
void syncFramerEmbed();

Vendor documentation

Bridge boundaries and remounts

Framer normally renders srcdoc without sandbox. Only the direct parent with browser-verified same-origin access receives events; no broadcasts or open postMessage channels. Opaque, foreign and nested frames stay gated. Parent whenDefined does not wait for the child. After navigation or breakpoint remounts, bind the load listener to the new frame and restore the current CMP choice. The parent dataLayer and queued events outlive a removed frame. Without a successor embed no local gate listener exists to release these queued events. Tracking failure never prevents booking.

Explicit host delegation

Only when your GTM fully controls tag consent, explicitly set tracking-consent="host". Events then push immediately; the host owns consent. Its own deduplication markers may be stored before a separate tracking grant. Other gated embeds gain neither consent nor general storage. Set the attribute before the element is first connected. This is not part of the default snippet.

<booking-embed src="https://book.example.invalid/coach/intro"
  tracking-consent="host"></booking-embed>

GTM trigger

Create a Custom Event trigger with regular-expression matching and the expression below. Add Data Layer Variables for funnel_id, mode, language, lead_id and booking_id. Connect GA4/conversion tags and preserve their consent checks; never add contact fields or enhanced conversions.

^(form_started|lead_captured|booking_confirmed)$

Device storage and deduplication

booking-tracking:v1 in host-origin sessionStorage (parent origin for Framer) contains only technical form/lead/booking anchors and the event allowlist, no contact details. General tracking writes start after the first grant; host delegation permits only its own markers. Consent grants stay transient. Version 2 contains delegated sent/forms only; version 1 proves a prior first grant, never current consent. Separately, booking:<funnel_id> stores the functional draft with contact details, answers and capture receipt including the lead capability, independently of tracking consent. The functional draft also holds the original booking request (contact details, answers, attribution and any lead capability), slot, zone, key, creation time and retention for a deliberate retry. The API reports its configured retention in the optional X-Booking-Attempt-Max-Age header (seconds); expired attempts are discarded. Unknown retention leaves an inactive draft: after reload confirmed retention is required before sending. It is removed after successful booking. Otherwise storage lasts until tab close or deletion. Without session storage deduplication lasts only in the document. A form operation ends after successful booking. One capture per funnel/lead ID and one booking event per funnel/booking ID. No global exactly-once delivery guarantee.

Hosted pages and lost responses

Hosted booking pages load no per-funnel tag IDs and currently provide no host-code/CMP integration. Their events stay gated in memory without consent integration. Tracking never creates bookings or automatically resubmits after reload. If a response is lost before the booking ID becomes known, tracking cannot deliver that unknown booking event later.

WordPress, Webflow and published pages

Insert the snippet in an HTML/code block and allow JavaScript on the published page. dataLayer and the CMP belong to that page. An additional Framer sandbox requires same-origin access. All three events appear only in the parent dataLayer. Local fixtures do not replace verification on the published target page. Test GTM using the embed on your own published test page: ?sandbox does not enable test mode there; the embed makes real bookings. Cancel test bookings afterwards. window.bookingTracking.setConsent is available only after bridge installation and is not a readiness signal.

GTM Preview checklist

The built-in GTM Event variable supplies the event name. Undecided: no pushes. Grant: queued events are released. Refusal: queued events are permanently discarded. Book during refusal, later grant and reload: no replay (observe the accepted origin/return boundary below). Never add contact fields or enhanced conversions. Successful booking and reload must not duplicate lead/booking events. Verify on the published WordPress, Webflow or Framer page, including navigation and breakpoints.

Boundary when granting consent on another page

Before the first grant no refusal marker is stored (except explicitly delegated own deduplication markers). After refusing mid-form, granting consent on another page without an embed or for another funnel, then returning, the former refusal cannot be distinguished from a formerly undecided visit. Editing the restored form may then emit form_started and lead_captured, including when the CMP supplies approval asynchronously. This boundary is deliberately accepted; no pre-consent storage is added for it. An existing refusal supplied again still discards restored anchors as before.

Stable (v1)

GET /v1/funnels/{funnelId}/slots

getFunnelSlots

Required scopes: ["read:funnels"]

Request and responses
{
  "operationId": "getFunnelSlots",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "format": "date-time",
        "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
      },
      "in": "query",
      "name": "from",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "format": "date-time",
        "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
      },
      "in": "query",
      "name": "to",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100,
        "default": "UTC"
      },
      "in": "query",
      "name": "timeZone",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "funnelId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:funnels"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "slots"
            ],
            "properties": {
              "slots": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "start",
                    "end",
                    "timeZone",
                    "local"
                  ],
                  "properties": {
                    "start": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "end": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "timeZone": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 100
                    },
                    "local": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "date",
                        "time",
                        "offset"
                      ],
                      "properties": {
                        "date": {
                          "type": "string",
                          "format": "date"
                        },
                        "time": {
                          "type": "string",
                          "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                        },
                        "offset": {
                          "type": "string",
                          "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

GET /v1/slots

getSlots

Required scopes: ["read:funnels"]

Request and responses
{
  "operationId": "getSlots",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "format": "date-time",
        "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
      },
      "in": "query",
      "name": "from",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "format": "date-time",
        "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
      },
      "in": "query",
      "name": "to",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100,
        "default": "UTC"
      },
      "in": "query",
      "name": "timeZone",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "query",
      "name": "funnelId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:funnels"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "slots"
            ],
            "properties": {
              "slots": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "start",
                    "end",
                    "timeZone",
                    "local"
                  ],
                  "properties": {
                    "start": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "end": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "timeZone": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 100
                    },
                    "local": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "date",
                        "time",
                        "offset"
                      ],
                      "properties": {
                        "date": {
                          "type": "string",
                          "format": "date"
                        },
                        "time": {
                          "type": "string",
                          "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                        },
                        "offset": {
                          "type": "string",
                          "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

POST /v1/bookings

createBooking

Required scopes: ["write:bookings"]

Request and responses
{
  "operationId": "createBooking",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "funnelId",
            "start",
            "timeZone",
            "invitee",
            "consent"
          ],
          "properties": {
            "funnelId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "leadId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "leadToken": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "start": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            },
            "timeZone": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "invitee": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "name",
                "email"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "email": {
                  "type": "string",
                  "format": "email",
                  "maxLength": 320
                },
                "phone": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                }
              }
            },
            "consent": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "followup"
              ],
              "properties": {
                "followup": {
                  "type": "boolean"
                },
                "text": {
                  "type": "string",
                  "nullable": true,
                  "maxLength": 4000
                },
                "timestamp": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                  "nullable": true
                }
              }
            },
            "responses": {
              "type": "object",
              "additionalProperties": true
            },
            "attribution": {
              "type": "object",
              "additionalProperties": {
                "type": "string",
                "maxLength": 2000
              }
            },
            "formVersion": {
              "type": "integer",
              "minimum": 1
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:bookings"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "funnelId",
              "hostId",
              "leadId",
              "start",
              "end",
              "timeZone",
              "inviteeTimeZone",
              "status",
              "createdAt",
              "formVersion"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "funnelId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "teamId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "leadId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "start": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "end": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "timeZone": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "inviteeTimeZone": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending_confirmation",
                  "confirmed",
                  "rescheduled",
                  "cancelled",
                  "expired",
                  "completed",
                  "no_show"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "rescheduleUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "cancelUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "confirmationUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "confirmationExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "bookingChangeHint": {
                "type": "string",
                "description": "Host-provided contact instruction when modification links are unavailable."
              },
              "meetingUrl": {
                "type": "string",
                "format": "uri"
              },
              "version": {
                "type": "integer",
                "minimum": 1
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "formVersion": {
                "type": "integer",
                "minimum": 1
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/bookings

listBookings

Required scopes: ["read:bookings"]

Request and responses
{
  "operationId": "listBookings",
  "parameters": [
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 25
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 0,
        "maximum": 2147483647,
        "default": 0
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "query",
      "name": "leadId",
      "required": false
    },
    {
      "schema": {
        "type": "boolean"
      },
      "in": "query",
      "name": "invitation_failed",
      "required": false,
      "description": "Filter bookings whose latest invitation operation failed."
    },
    {
      "schema": {
        "type": "string",
        "maxLength": 200
      },
      "in": "query",
      "name": "search",
      "required": false,
      "description": "Case-insensitive substring match on invitee name, email or funnel name."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "query",
      "name": "funnelId",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "query",
      "name": "hostId",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "pending_confirmation",
          "confirmed",
          "rescheduled",
          "cancelled",
          "expired",
          "completed",
          "no_show"
        ]
      },
      "in": "query",
      "name": "status",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "format": "date-time",
        "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
      },
      "in": "query",
      "name": "from",
      "required": false,
      "description": "Inclusive booking start."
    },
    {
      "schema": {
        "type": "string",
        "format": "date-time",
        "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
      },
      "in": "query",
      "name": "to",
      "required": false,
      "description": "Exclusive booking start."
    },
    {
      "schema": {
        "type": "string",
        "format": "date-time",
        "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
      },
      "in": "query",
      "name": "updated_since",
      "required": false,
      "description": "Inclusive update instant; creation time for legacy rows without updatedAt."
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "start",
          "created_at",
          "updated_at"
        ],
        "default": "start"
      },
      "in": "query",
      "name": "sort",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "asc",
          "desc"
        ],
        "default": "asc"
      },
      "in": "query",
      "name": "order",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:bookings"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "workspaceId",
                    "funnelId",
                    "hostId",
                    "leadId",
                    "start",
                    "end",
                    "timeZone",
                    "inviteeTimeZone",
                    "status",
                    "createdAt",
                    "formVersion",
                    "invitee",
                    "funnelName"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "workspaceId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "funnelId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "hostId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "teamId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "leadId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "start": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "end": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "timeZone": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 100
                    },
                    "inviteeTimeZone": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 100
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "pending_confirmation",
                        "confirmed",
                        "rescheduled",
                        "cancelled",
                        "expired",
                        "completed",
                        "no_show"
                      ]
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "rescheduleUrl": {
                      "type": "string",
                      "format": "uri",
                      "description": "Only returned with write:bookings."
                    },
                    "cancelUrl": {
                      "type": "string",
                      "format": "uri",
                      "description": "Only returned with write:bookings."
                    },
                    "confirmationUrl": {
                      "type": "string",
                      "format": "uri",
                      "description": "Only returned with write:bookings."
                    },
                    "confirmationExpiresAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "bookingChangeHint": {
                      "type": "string",
                      "description": "Host-provided contact instruction when modification links are unavailable."
                    },
                    "meetingUrl": {
                      "type": "string",
                      "format": "uri"
                    },
                    "version": {
                      "type": "integer",
                      "minimum": 1
                    },
                    "updatedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "formVersion": {
                      "type": "integer",
                      "minimum": 1
                    },
                    "funnelName": {
                      "type": "string",
                      "description": "The booking's link name, including archived links."
                    },
                    "calendarDisconnected": {
                      "type": "boolean",
                      "description": "Calendar access ended when the host left the workspace. Synchronization is suspended, not terminally failed; the owner must reassign the booking."
                    },
                    "invitationFailed": {
                      "type": "boolean",
                      "description": "The latest invitation could not be delivered; shown only in the authenticated host listing."
                    },
                    "invitee": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "name",
                        "email"
                      ],
                      "properties": {
                        "name": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 200
                        },
                        "email": {
                          "type": "string",
                          "format": "email"
                        }
                      }
                    }
                  }
                }
              },
              "total": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "limit": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "offset": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/bookings/{bookingId}

getBooking

Required scopes: ["read:bookings"]

Request and responses
{
  "operationId": "getBooking",
  "parameters": [
    {
      "schema": {
        "type": "string"
      },
      "in": "path",
      "name": "bookingId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:bookings"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "funnelId",
              "hostId",
              "leadId",
              "start",
              "end",
              "timeZone",
              "inviteeTimeZone",
              "status",
              "createdAt",
              "formVersion"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "funnelId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "teamId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "leadId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "start": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "end": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "timeZone": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "inviteeTimeZone": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending_confirmation",
                  "confirmed",
                  "rescheduled",
                  "cancelled",
                  "expired",
                  "completed",
                  "no_show"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "rescheduleUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "cancelUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "confirmationUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "confirmationExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "bookingChangeHint": {
                "type": "string",
                "description": "Host-provided contact instruction when modification links are unavailable."
              },
              "meetingUrl": {
                "type": "string",
                "format": "uri"
              },
              "version": {
                "type": "integer",
                "minimum": 1
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "formVersion": {
                "type": "integer",
                "minimum": 1
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

GET /v1/funnels/{funnelId}

getFunnel

Required scopes: ["read:funnels"]

Request and responses
{
  "operationId": "getFunnel",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "funnelId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:funnels"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "id",
              "name",
              "durationMinutes",
              "formVersion",
              "phoneRequired"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "timeZone": {
                "type": "string"
              },
              "teamId": {
                "type": "string"
              },
              "durationMinutes": {
                "type": "integer"
              },
              "formVersion": {
                "type": "integer"
              },
              "phoneRequired": {
                "type": "boolean"
              },
              "confirmationRequired": {
                "type": "boolean"
              },
              "rescheduleCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee rescheduling cutoff in hours; zero allows rescheduling at any time. Applies to current and already-issued booking links."
              },
              "cancellationCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee cancellation cutoff in hours; zero allows cancellation at any time. When absent, inherits rescheduleCutoffHours or the configured default."
              },
              "allowRescheduling": {
                "type": "boolean"
              },
              "allowCancellation": {
                "type": "boolean"
              },
              "bookingChangeHint": {
                "type": "string"
              },
              "locale": {
                "type": "string",
                "enum": [
                  "de",
                  "en"
                ]
              },
              "video": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "google_meet"
                        ]
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "url"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "custom"
                        ]
                      },
                      "url": {
                        "type": "string",
                        "format": "uri"
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

PATCH /v1/funnels/{funnelId}

updateFunnel

Every assigned host must have a non-empty name; otherwise returns 422 host_name_required.

Required scopes: ["write:funnels"]

Request and responses
{
  "operationId": "updateFunnel",
  "description": "Every assigned host must have a non-empty name; otherwise returns 422 host_name_required.",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "mode": {
              "type": "string",
              "enum": [
                "form_first",
                "calendar_first",
                "headless"
              ]
            },
            "captureAbandoned": {
              "type": "boolean",
              "description": "Available only in form_first. calendar_first and headless always use false and reject explicit true."
            },
            "bookingWindowDays": {
              "type": "integer",
              "minimum": 1,
              "maximum": 36500
            },
            "fields": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "id",
                  "type",
                  "required",
                  "label"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^[a-z][a-z0-9_]{0,79}$"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "text",
                      "email",
                      "phone",
                      "select",
                      "multiselect",
                      "scale",
                      "number",
                      "textarea",
                      "boolean",
                      "consent"
                    ]
                  },
                  "required": {
                    "type": "boolean"
                  },
                  "hidden": {
                    "type": "boolean"
                  },
                  "label": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "min": {
                    "type": "number",
                    "description": "Required integer lower bound for a scale; optional numeric lower bound for a number field."
                  },
                  "max": {
                    "type": "number",
                    "description": "Required integer upper bound greater than min for a scale; optional numeric upper bound for a number field."
                  },
                  "options": {
                    "type": "array",
                    "minItems": 1,
                    "maxItems": 100,
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "value",
                        "label"
                      ],
                      "properties": {
                        "value": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 80
                        },
                        "label": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            },
            "bookingCopy": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "headline",
                "subheadline",
                "submitLabel",
                "confirmation",
                "consent",
                "privacyLinkLabel",
                "privacyLinkSuffix",
                "captureNotice"
              ],
              "properties": {
                "headline": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "subheadline": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "submitLabel": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "confirmation": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "consent": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "privacyLinkLabel": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "privacyLinkSuffix": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "captureNotice": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                }
              }
            },
            "descriptionFormat": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "de",
                "en"
              ],
              "properties": {
                "de": {
                  "type": "string",
                  "enum": [
                    "plain",
                    "markdown"
                  ]
                },
                "en": {
                  "type": "string",
                  "enum": [
                    "plain",
                    "markdown"
                  ]
                }
              }
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "labels": {
              "type": "array",
              "maxItems": 3,
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "name",
                  "color"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 32
                  },
                  "color": {
                    "type": "string",
                    "enum": [
                      "blue",
                      "cyan",
                      "green",
                      "orange",
                      "pink",
                      "purple",
                      "gray"
                    ]
                  }
                }
              }
            },
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 63,
              "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
            },
            "hostId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "teamId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "availabilityProfileId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80,
              "nullable": true
            },
            "availability": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "days",
                  "startTime",
                  "endTime"
                ],
                "properties": {
                  "days": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 6
                    }
                  },
                  "startTime": {
                    "type": "string",
                    "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                  },
                  "endTime": {
                    "type": "string",
                    "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                  }
                }
              },
              "nullable": true,
              "deprecated": true,
              "description": "Unsupported. Select an availability profile with availabilityProfileId instead (422)."
            },
            "durationMinutes": {
              "type": "integer",
              "minimum": 1,
              "maximum": 2147483647
            },
            "intervalMinutes": {
              "type": "integer",
              "minimum": 1,
              "maximum": 2147483647
            },
            "bufferBeforeMinutes": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "bufferAfterMinutes": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "minimumNoticeMinutes": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "maxBookingsPerDay": {
              "type": "integer",
              "minimum": 1,
              "maximum": 2147483647
            },
            "phoneRequired": {
              "type": "boolean"
            },
            "confirmationRequired": {
              "type": "boolean",
              "description": "Require invitee confirmation before the configured expiry; an unconfirmed booking expires and releases its slot."
            },
            "locale": {
              "type": "string",
              "enum": [
                "de",
                "en"
              ]
            },
            "rescheduleCutoffHours": {
              "type": "number",
              "minimum": 0,
              "description": "Invitee rescheduling cutoff in hours. Zero permits rescheduling at any time."
            },
            "cancellationCutoffHours": {
              "type": "number",
              "minimum": 0,
              "description": "Invitee cancellation cutoff in hours. Zero permits cancellation at any time. When omitted on creation, inherits the rescheduling cutoff; existing settings are preserved on updates."
            },
            "allowRescheduling": {
              "type": "boolean",
              "description": "Allow invitees to reschedule, subject to the change cutoff. Defaults to true; hosts are exempt."
            },
            "allowCancellation": {
              "type": "boolean",
              "description": "Allow invitees to cancel, subject to the change cutoff. Defaults to true; hosts are exempt."
            },
            "bookingChangeHint": {
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            },
            "video": {
              "oneOf": [
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "kind"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "google_meet"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "kind",
                    "url"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "custom"
                      ]
                    },
                    "url": {
                      "type": "string",
                      "format": "uri",
                      "pattern": "^https://",
                      "maxLength": 2000
                    }
                  }
                }
              ]
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "funnelId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:funnels"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "createdAt",
              "name",
              "slug",
              "publicationStatus",
              "publicUrl",
              "durationMinutes",
              "intervalMinutes",
              "bufferBeforeMinutes",
              "bufferAfterMinutes",
              "minimumNoticeMinutes",
              "maxBookingsPerDay",
              "phoneRequired",
              "confirmationRequired",
              "locale",
              "rescheduleCutoffHours",
              "formVersion",
              "availabilityProfileId",
              "mode",
              "captureAbandoned",
              "bookingWindowDays",
              "fields",
              "bookingCopy"
            ],
            "properties": {
              "mode": {
                "type": "string",
                "enum": [
                  "form_first",
                  "calendar_first",
                  "headless"
                ]
              },
              "captureAbandoned": {
                "type": "boolean",
                "description": "Available only in form_first. calendar_first and headless always use false and reject explicit true."
              },
              "bookingWindowDays": {
                "type": "integer",
                "minimum": 1,
                "maximum": 36500
              },
              "fields": {
                "type": "array",
                "maxItems": 100,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "type",
                    "required",
                    "label"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{0,79}$"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "text",
                        "email",
                        "phone",
                        "select",
                        "multiselect",
                        "scale",
                        "number",
                        "textarea",
                        "boolean",
                        "consent"
                      ]
                    },
                    "required": {
                      "type": "boolean"
                    },
                    "hidden": {
                      "type": "boolean"
                    },
                    "label": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    },
                    "min": {
                      "type": "number",
                      "description": "Required integer lower bound for a scale; optional numeric lower bound for a number field."
                    },
                    "max": {
                      "type": "number",
                      "description": "Required integer upper bound greater than min for a scale; optional numeric upper bound for a number field."
                    },
                    "options": {
                      "type": "array",
                      "minItems": 1,
                      "maxItems": 100,
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "value",
                          "label"
                        ],
                        "properties": {
                          "value": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 80
                          },
                          "label": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "de",
                              "en"
                            ],
                            "properties": {
                              "de": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              },
                              "en": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              },
              "bookingCopy": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "headline",
                  "subheadline",
                  "submitLabel",
                  "confirmation",
                  "consent",
                  "privacyLinkLabel",
                  "privacyLinkSuffix",
                  "captureNotice"
                ],
                "properties": {
                  "headline": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "subheadline": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "submitLabel": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "confirmation": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "consent": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "privacyLinkLabel": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "privacyLinkSuffix": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "captureNotice": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  }
                }
              },
              "descriptionFormat": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "de",
                  "en"
                ],
                "properties": {
                  "de": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "markdown"
                    ]
                  },
                  "en": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "markdown"
                    ]
                  }
                }
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "labels": {
                "type": "array",
                "maxItems": 3,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "color"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32
                    },
                    "color": {
                      "type": "string",
                      "enum": [
                        "blue",
                        "cyan",
                        "green",
                        "orange",
                        "pink",
                        "purple",
                        "gray"
                      ]
                    }
                  }
                }
              },
              "slug": {
                "type": "string",
                "minLength": 1,
                "maxLength": 63,
                "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
                "nullable": true
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "teamId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "availabilityProfileId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "nullable": true
              },
              "durationMinutes": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "intervalMinutes": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "bufferBeforeMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "bufferAfterMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "minimumNoticeMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "maxBookingsPerDay": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "phoneRequired": {
                "type": "boolean"
              },
              "confirmationRequired": {
                "type": "boolean",
                "description": "Require invitee confirmation before the configured expiry; an unconfirmed booking expires and releases its slot."
              },
              "locale": {
                "type": "string",
                "enum": [
                  "de",
                  "en"
                ]
              },
              "rescheduleCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee rescheduling cutoff in hours. Zero permits rescheduling at any time."
              },
              "cancellationCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee cancellation cutoff in hours. Zero permits cancellation at any time. When omitted on creation, inherits the rescheduling cutoff; existing settings are preserved on updates."
              },
              "allowRescheduling": {
                "type": "boolean",
                "description": "Allow invitees to reschedule, subject to the change cutoff. Defaults to true; hosts are exempt."
              },
              "allowCancellation": {
                "type": "boolean",
                "description": "Allow invitees to cancel, subject to the change cutoff. Defaults to true; hosts are exempt."
              },
              "bookingChangeHint": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "video": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "google_meet"
                        ]
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "url"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "custom"
                        ]
                      },
                      "url": {
                        "type": "string",
                        "format": "uri",
                        "pattern": "^https://",
                        "maxLength": 2000
                      }
                    }
                  }
                ]
              },
              "publicationStatus": {
                "type": "string",
                "enum": [
                  "draft",
                  "published"
                ]
              },
              "publicUrl": {
                "type": "string",
                "nullable": true,
                "format": "uri"
              },
              "templateId": {
                "type": "string",
                "enum": [
                  "coaching_intro"
                ]
              },
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "formVersion": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

DELETE /v1/funnels/{funnelId}

deleteFunnel

Removes the booking link while retaining existing leads and bookings.

Required scopes: ["write:funnels"]

Request and responses
{
  "operationId": "deleteFunnel",
  "description": "Removes the booking link while retaining existing leads and bookings.",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "funnelId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:funnels"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "createdAt",
              "name",
              "slug",
              "publicationStatus",
              "publicUrl",
              "durationMinutes",
              "intervalMinutes",
              "bufferBeforeMinutes",
              "bufferAfterMinutes",
              "minimumNoticeMinutes",
              "maxBookingsPerDay",
              "phoneRequired",
              "confirmationRequired",
              "locale",
              "rescheduleCutoffHours",
              "formVersion",
              "availabilityProfileId",
              "mode",
              "captureAbandoned",
              "bookingWindowDays",
              "fields",
              "bookingCopy"
            ],
            "properties": {
              "mode": {
                "type": "string",
                "enum": [
                  "form_first",
                  "calendar_first",
                  "headless"
                ]
              },
              "captureAbandoned": {
                "type": "boolean",
                "description": "Available only in form_first. calendar_first and headless always use false and reject explicit true."
              },
              "bookingWindowDays": {
                "type": "integer",
                "minimum": 1,
                "maximum": 36500
              },
              "fields": {
                "type": "array",
                "maxItems": 100,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "type",
                    "required",
                    "label"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{0,79}$"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "text",
                        "email",
                        "phone",
                        "select",
                        "multiselect",
                        "scale",
                        "number",
                        "textarea",
                        "boolean",
                        "consent"
                      ]
                    },
                    "required": {
                      "type": "boolean"
                    },
                    "hidden": {
                      "type": "boolean"
                    },
                    "label": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    },
                    "min": {
                      "type": "number",
                      "description": "Required integer lower bound for a scale; optional numeric lower bound for a number field."
                    },
                    "max": {
                      "type": "number",
                      "description": "Required integer upper bound greater than min for a scale; optional numeric upper bound for a number field."
                    },
                    "options": {
                      "type": "array",
                      "minItems": 1,
                      "maxItems": 100,
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "value",
                          "label"
                        ],
                        "properties": {
                          "value": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 80
                          },
                          "label": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "de",
                              "en"
                            ],
                            "properties": {
                              "de": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              },
                              "en": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              },
              "bookingCopy": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "headline",
                  "subheadline",
                  "submitLabel",
                  "confirmation",
                  "consent",
                  "privacyLinkLabel",
                  "privacyLinkSuffix",
                  "captureNotice"
                ],
                "properties": {
                  "headline": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "subheadline": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "submitLabel": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "confirmation": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "consent": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "privacyLinkLabel": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "privacyLinkSuffix": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "captureNotice": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  }
                }
              },
              "descriptionFormat": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "de",
                  "en"
                ],
                "properties": {
                  "de": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "markdown"
                    ]
                  },
                  "en": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "markdown"
                    ]
                  }
                }
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "labels": {
                "type": "array",
                "maxItems": 3,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "color"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32
                    },
                    "color": {
                      "type": "string",
                      "enum": [
                        "blue",
                        "cyan",
                        "green",
                        "orange",
                        "pink",
                        "purple",
                        "gray"
                      ]
                    }
                  }
                }
              },
              "slug": {
                "type": "string",
                "minLength": 1,
                "maxLength": 63,
                "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
                "nullable": true
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "teamId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "availabilityProfileId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "nullable": true
              },
              "durationMinutes": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "intervalMinutes": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "bufferBeforeMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "bufferAfterMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "minimumNoticeMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "maxBookingsPerDay": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "phoneRequired": {
                "type": "boolean"
              },
              "confirmationRequired": {
                "type": "boolean",
                "description": "Require invitee confirmation before the configured expiry; an unconfirmed booking expires and releases its slot."
              },
              "locale": {
                "type": "string",
                "enum": [
                  "de",
                  "en"
                ]
              },
              "rescheduleCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee rescheduling cutoff in hours. Zero permits rescheduling at any time."
              },
              "cancellationCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee cancellation cutoff in hours. Zero permits cancellation at any time. When omitted on creation, inherits the rescheduling cutoff; existing settings are preserved on updates."
              },
              "allowRescheduling": {
                "type": "boolean",
                "description": "Allow invitees to reschedule, subject to the change cutoff. Defaults to true; hosts are exempt."
              },
              "allowCancellation": {
                "type": "boolean",
                "description": "Allow invitees to cancel, subject to the change cutoff. Defaults to true; hosts are exempt."
              },
              "bookingChangeHint": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "video": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "google_meet"
                        ]
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "url"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "custom"
                        ]
                      },
                      "url": {
                        "type": "string",
                        "format": "uri",
                        "pattern": "^https://",
                        "maxLength": 2000
                      }
                    }
                  }
                ]
              },
              "publicationStatus": {
                "type": "string",
                "enum": [
                  "draft",
                  "published"
                ]
              },
              "publicUrl": {
                "type": "string",
                "nullable": true,
                "format": "uri"
              },
              "templateId": {
                "type": "string",
                "enum": [
                  "coaching_intro"
                ]
              },
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "formVersion": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/integrations/google/connect

connectGoogleCalendar

Required scopes: ["write:bookings"]

Request and responses
{
  "operationId": "connectGoogleCalendar",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {},
          "additionalProperties": false
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:bookings"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "authorizationUrl",
              "expiresAt"
            ],
            "properties": {
              "authorizationUrl": {
                "type": "string",
                "format": "uri"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/integrations/google

getGoogleCalendarConnection

Required scopes: ["read:bookings"]

Request and responses
{
  "operationId": "getGoogleCalendarConnection",
  "parameters": [
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:bookings"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "connected"
            ],
            "properties": {
              "connected": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/hosts/{hostId}/google/connect

connectHostGoogleCalendar

Required scopes: ["write:hosts"]

Request and responses
{
  "operationId": "connectHostGoogleCalendar",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {}
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^hs_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "hostId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:hosts"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "authorizationUrl",
              "expiresAt"
            ],
            "properties": {
              "authorizationUrl": {
                "type": "string",
                "format": "uri"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/hosts/{hostId}/google

getHostGoogleCalendarConnection

Required scopes: ["read:hosts"]

Request and responses
{
  "operationId": "getHostGoogleCalendarConnection",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^hs_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "hostId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:hosts"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "connected"
            ],
            "properties": {
              "connected": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/bookings/{bookingId}/confirm

confirmBooking

Required scopes: ["write:bookings"]

Request and responses
{
  "operationId": "confirmBooking",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "bookingId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "bookingLink": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:bookings"
  ],
  "x-booking-link-action": "confirm",
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "funnelId",
              "hostId",
              "leadId",
              "start",
              "end",
              "timeZone",
              "inviteeTimeZone",
              "status",
              "createdAt",
              "formVersion"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "funnelId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "teamId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "leadId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "start": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "end": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "timeZone": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "inviteeTimeZone": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending_confirmation",
                  "confirmed",
                  "rescheduled",
                  "cancelled",
                  "expired",
                  "completed",
                  "no_show"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "rescheduleUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "cancelUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "confirmationUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "confirmationExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "bookingChangeHint": {
                "type": "string",
                "description": "Host-provided contact instruction when modification links are unavailable."
              },
              "meetingUrl": {
                "type": "string",
                "format": "uri"
              },
              "version": {
                "type": "integer",
                "minimum": 1
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "formVersion": {
                "type": "integer",
                "minimum": 1
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

POST /v1/bookings/{bookingId}/cancel

cancelBooking

Required scopes: ["write:bookings"]

Request and responses
{
  "operationId": "cancelBooking",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "bookingId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "bookingLink": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:bookings"
  ],
  "x-booking-link-action": "cancel",
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "funnelId",
              "hostId",
              "leadId",
              "start",
              "end",
              "timeZone",
              "inviteeTimeZone",
              "status",
              "createdAt",
              "formVersion"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "funnelId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "teamId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "leadId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "start": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "end": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "timeZone": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "inviteeTimeZone": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending_confirmation",
                  "confirmed",
                  "rescheduled",
                  "cancelled",
                  "expired",
                  "completed",
                  "no_show"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "rescheduleUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "cancelUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "confirmationUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "confirmationExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "bookingChangeHint": {
                "type": "string",
                "description": "Host-provided contact instruction when modification links are unavailable."
              },
              "meetingUrl": {
                "type": "string",
                "format": "uri"
              },
              "version": {
                "type": "integer",
                "minimum": 1
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "formVersion": {
                "type": "integer",
                "minimum": 1
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

POST /v1/bookings/{bookingId}/reschedule

rescheduleBooking

Required scopes: ["write:bookings"]

Request and responses
{
  "operationId": "rescheduleBooking",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "start",
            "timeZone"
          ],
          "properties": {
            "start": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            },
            "timeZone": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "bookingId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "bookingLink": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:bookings"
  ],
  "x-booking-link-action": "reschedule",
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "funnelId",
              "hostId",
              "leadId",
              "start",
              "end",
              "timeZone",
              "inviteeTimeZone",
              "status",
              "createdAt",
              "formVersion"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "funnelId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "teamId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "leadId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "start": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "end": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "timeZone": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "inviteeTimeZone": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending_confirmation",
                  "confirmed",
                  "rescheduled",
                  "cancelled",
                  "expired",
                  "completed",
                  "no_show"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "rescheduleUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "cancelUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "confirmationUrl": {
                "type": "string",
                "format": "uri",
                "description": "Only returned with write:bookings."
              },
              "confirmationExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "bookingChangeHint": {
                "type": "string",
                "description": "Host-provided contact instruction when modification links are unavailable."
              },
              "meetingUrl": {
                "type": "string",
                "format": "uri"
              },
              "version": {
                "type": "integer",
                "minimum": 1
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "formVersion": {
                "type": "integer",
                "minimum": 1
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

GET /v1/webhooks/capabilities

getWebhookCapabilities

Webhook availability for the current workspace, including the operator's workspace restriction. The global rollout defaults to disabled.

Required scopes: ["read:webhooks"]

Request and responses
{
  "operationId": "getWebhookCapabilities",
  "tags": [
    "webhooks"
  ],
  "description": "Webhook availability for the current workspace, including the operator's workspace restriction. The global rollout defaults to disabled.",
  "parameters": [
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:webhooks"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "enabled"
            ],
            "properties": {
              "enabled": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

GET /v1/webhooks

listWebhookEndpoints

Required scopes: ["read:webhooks"]

Request and responses
{
  "operationId": "listWebhookEndpoints",
  "tags": [
    "webhooks"
  ],
  "parameters": [
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 0,
        "maximum": 2147483647
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:webhooks"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "url",
                    "events",
                    "status",
                    "createdAt",
                    "updatedAt",
                    "deletedAt"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
                    },
                    "url": {
                      "type": "string",
                      "format": "uri"
                    },
                    "events": {
                      "type": "array",
                      "minItems": 1,
                      "uniqueItems": true,
                      "items": {
                        "type": "string",
                        "enum": [
                          "lead.captured",
                          "lead.abandoned",
                          "lead.converted",
                          "booking.created",
                          "booking.rescheduled",
                          "booking.cancelled",
                          "booking.confirmed_by_invitee",
                          "booking.expired",
                          "booking.completed"
                        ]
                      },
                      "description": "Events to deliver. Omitting this on creation subscribes to all nine available events. lead.disqualified and booking.no_show are reserved and cannot be selected yet."
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "active",
                        "paused"
                      ]
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "updatedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "deletedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                      "nullable": true
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

POST /v1/webhooks

createWebhookEndpoint

Creates an active endpoint. Only subsequent events are eligible. The returned secret is shown once; idempotent retries return the same result.

Required scopes: ["write:webhooks"]

Request and responses
{
  "operationId": "createWebhookEndpoint",
  "tags": [
    "webhooks"
  ],
  "description": "Creates an active endpoint. Only subsequent events are eligible. The returned secret is shown once; idempotent retries return the same result.",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "url"
          ],
          "properties": {
            "url": {
              "type": "string",
              "format": "uri",
              "maxLength": 2048,
              "description": "Public HTTPS destination without credentials or fragments. DNS and SSRF checks run on registration, URL changes and every delivery attempt. Redirects are never followed."
            },
            "events": {
              "type": "array",
              "minItems": 1,
              "uniqueItems": true,
              "items": {
                "type": "string",
                "enum": [
                  "lead.captured",
                  "lead.abandoned",
                  "lead.converted",
                  "booking.created",
                  "booking.rescheduled",
                  "booking.cancelled",
                  "booking.confirmed_by_invitee",
                  "booking.expired",
                  "booking.completed"
                ]
              },
              "description": "Events to deliver. Omitting this on creation subscribes to all nine available events. lead.disqualified and booking.no_show are reserved and cannot be selected yet."
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:webhooks"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "endpoint",
              "secret"
            ],
            "properties": {
              "endpoint": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "id",
                  "url",
                  "events",
                  "status",
                  "createdAt",
                  "updatedAt",
                  "deletedAt"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
                  },
                  "url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "events": {
                    "type": "array",
                    "minItems": 1,
                    "uniqueItems": true,
                    "items": {
                      "type": "string",
                      "enum": [
                        "lead.captured",
                        "lead.abandoned",
                        "lead.converted",
                        "booking.created",
                        "booking.rescheduled",
                        "booking.cancelled",
                        "booking.confirmed_by_invitee",
                        "booking.expired",
                        "booking.completed"
                      ]
                    },
                    "description": "Events to deliver. Omitting this on creation subscribes to all nine available events. lead.disqualified and booking.no_show are reserved and cannot be selected yet."
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "active",
                      "paused"
                    ]
                  },
                  "createdAt": {
                    "type": "string",
                    "format": "date-time",
                    "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                  },
                  "updatedAt": {
                    "type": "string",
                    "format": "date-time",
                    "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                  },
                  "deletedAt": {
                    "type": "string",
                    "format": "date-time",
                    "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                    "nullable": true
                  }
                }
              },
              "secret": {
                "type": "string",
                "description": "Shown only when creating or rotating the secret, including an idempotent replay of that request. Use this entire UTF-8 string for HMAC; do not Base64-decode it."
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

GET /v1/webhooks/{endpointId}

getWebhookEndpoint

Required scopes: ["read:webhooks"]

Request and responses
{
  "operationId": "getWebhookEndpoint",
  "tags": [
    "webhooks"
  ],
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "endpointId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:webhooks"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "url",
              "events",
              "status",
              "createdAt",
              "updatedAt",
              "deletedAt"
            ],
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
              },
              "url": {
                "type": "string",
                "format": "uri"
              },
              "events": {
                "type": "array",
                "minItems": 1,
                "uniqueItems": true,
                "items": {
                  "type": "string",
                  "enum": [
                    "lead.captured",
                    "lead.abandoned",
                    "lead.converted",
                    "booking.created",
                    "booking.rescheduled",
                    "booking.cancelled",
                    "booking.confirmed_by_invitee",
                    "booking.expired",
                    "booking.completed"
                  ]
                },
                "description": "Events to deliver. Omitting this on creation subscribes to all nine available events. lead.disqualified and booking.no_show are reserved and cannot be selected yet."
              },
              "status": {
                "type": "string",
                "enum": [
                  "active",
                  "paused"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "deletedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                "nullable": true
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

PATCH /v1/webhooks/{endpointId}

updateWebhookEndpoint

Required scopes: ["write:webhooks"]

Request and responses
{
  "operationId": "updateWebhookEndpoint",
  "tags": [
    "webhooks"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "minProperties": 1,
          "properties": {
            "url": {
              "type": "string",
              "format": "uri",
              "maxLength": 2048,
              "description": "Public HTTPS destination without credentials or fragments. DNS and SSRF checks run on registration, URL changes and every delivery attempt. Redirects are never followed."
            },
            "events": {
              "type": "array",
              "minItems": 1,
              "uniqueItems": true,
              "items": {
                "type": "string",
                "enum": [
                  "lead.captured",
                  "lead.abandoned",
                  "lead.converted",
                  "booking.created",
                  "booking.rescheduled",
                  "booking.cancelled",
                  "booking.confirmed_by_invitee",
                  "booking.expired",
                  "booking.completed"
                ]
              },
              "description": "Events to deliver. Omitting this on creation subscribes to all nine available events. lead.disqualified and booking.no_show are reserved and cannot be selected yet."
            },
            "status": {
              "type": "string",
              "enum": [
                "active",
                "paused"
              ]
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "endpointId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:webhooks"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "url",
              "events",
              "status",
              "createdAt",
              "updatedAt",
              "deletedAt"
            ],
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
              },
              "url": {
                "type": "string",
                "format": "uri"
              },
              "events": {
                "type": "array",
                "minItems": 1,
                "uniqueItems": true,
                "items": {
                  "type": "string",
                  "enum": [
                    "lead.captured",
                    "lead.abandoned",
                    "lead.converted",
                    "booking.created",
                    "booking.rescheduled",
                    "booking.cancelled",
                    "booking.confirmed_by_invitee",
                    "booking.expired",
                    "booking.completed"
                  ]
                },
                "description": "Events to deliver. Omitting this on creation subscribes to all nine available events. lead.disqualified and booking.no_show are reserved and cannot be selected yet."
              },
              "status": {
                "type": "string",
                "enum": [
                  "active",
                  "paused"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "deletedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                "nullable": true
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

DELETE /v1/webhooks/{endpointId}

deleteWebhookEndpoint

Stops future delivery while preserving the delivery history.

Required scopes: ["write:webhooks"]

Request and responses
{
  "operationId": "deleteWebhookEndpoint",
  "tags": [
    "webhooks"
  ],
  "description": "Stops future delivery while preserving the delivery history.",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "endpointId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:webhooks"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "id",
              "deletedAt"
            ],
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
              },
              "deletedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

POST /v1/webhooks/{endpointId}/rotate-secret

rotateWebhookSecret

Replaces the endpoint secret immediately. An already running attempt may still use the previous secret; accept both during receiver rollout. Only this response reveals the new secret.

Required scopes: ["write:webhooks"]

Request and responses
{
  "operationId": "rotateWebhookSecret",
  "tags": [
    "webhooks"
  ],
  "description": "Replaces the endpoint secret immediately. An already running attempt may still use the previous secret; accept both during receiver rollout. Only this response reveals the new secret.",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "endpointId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:webhooks"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "endpoint",
              "secret"
            ],
            "properties": {
              "endpoint": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "id",
                  "url",
                  "events",
                  "status",
                  "createdAt",
                  "updatedAt",
                  "deletedAt"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
                  },
                  "url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "events": {
                    "type": "array",
                    "minItems": 1,
                    "uniqueItems": true,
                    "items": {
                      "type": "string",
                      "enum": [
                        "lead.captured",
                        "lead.abandoned",
                        "lead.converted",
                        "booking.created",
                        "booking.rescheduled",
                        "booking.cancelled",
                        "booking.confirmed_by_invitee",
                        "booking.expired",
                        "booking.completed"
                      ]
                    },
                    "description": "Events to deliver. Omitting this on creation subscribes to all nine available events. lead.disqualified and booking.no_show are reserved and cannot be selected yet."
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "active",
                      "paused"
                    ]
                  },
                  "createdAt": {
                    "type": "string",
                    "format": "date-time",
                    "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                  },
                  "updatedAt": {
                    "type": "string",
                    "format": "date-time",
                    "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                  },
                  "deletedAt": {
                    "type": "string",
                    "format": "date-time",
                    "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                    "nullable": true
                  }
                }
              },
              "secret": {
                "type": "string",
                "description": "Shown only when creating or rotating the secret, including an idempotent replay of that request. Use this entire UTF-8 string for HMAC; do not Base64-decode it."
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

POST /v1/webhooks/{endpointId}/test

sendWebhookTestEvent

Queues a synthetic example with data.test=true through the same signing, SSRF and retry path. The response confirms queuing, not remote acceptance. A paused endpoint must first be resumed.

Required scopes: ["write:webhooks"]

Request and responses
{
  "operationId": "sendWebhookTestEvent",
  "tags": [
    "webhooks"
  ],
  "description": "Queues a synthetic example with data.test=true through the same signing, SSRF and retry path. The response confirms queuing, not remote acceptance. A paused endpoint must first be resumed.",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "endpointId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:webhooks"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "202": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "endpointId",
              "eventId",
              "eventType",
              "status",
              "attemptCount",
              "nextAttemptAt",
              "createdAt",
              "completedAt",
              "lastStatusCode",
              "lastError",
              "replayId"
            ],
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^wd_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
              },
              "endpointId": {
                "type": "string",
                "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
              },
              "eventId": {
                "type": "string"
              },
              "eventType": {
                "type": "string",
                "enum": [
                  "lead.captured",
                  "lead.abandoned",
                  "lead.converted",
                  "booking.created",
                  "booking.rescheduled",
                  "booking.cancelled",
                  "booking.confirmed_by_invitee",
                  "booking.expired",
                  "booking.completed"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "delivering",
                  "succeeded",
                  "dead_letter"
                ]
              },
              "attemptCount": {
                "type": "integer",
                "minimum": 0
              },
              "nextAttemptAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                "nullable": true
              },
              "waitingForEventId": {
                "type": "string",
                "nullable": true,
                "description": "Unmet lead.captured event ID for a pending booking.created. Null once any original or replay capture delivery succeeds; optional on older releases."
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "completedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                "nullable": true
              },
              "lastStatusCode": {
                "type": "integer",
                "nullable": true
              },
              "lastError": {
                "type": "string",
                "nullable": true
              },
              "replayId": {
                "type": "string",
                "nullable": true,
                "description": "Explicit replay identity; null for an original delivery. Replays retain the original eventId and body."
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

GET /v1/webhook-deliveries

listWebhookDeliveries

Required scopes: ["read:webhooks"]

Request and responses
{
  "operationId": "listWebhookDeliveries",
  "tags": [
    "webhooks"
  ],
  "parameters": [
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 0,
        "maximum": 2147483647
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "query",
      "name": "endpointId",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "pending",
          "delivering",
          "succeeded",
          "dead_letter"
        ]
      },
      "in": "query",
      "name": "status",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:webhooks"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "endpointId",
                    "eventId",
                    "eventType",
                    "status",
                    "attemptCount",
                    "nextAttemptAt",
                    "createdAt",
                    "completedAt",
                    "lastStatusCode",
                    "lastError",
                    "replayId"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^wd_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
                    },
                    "endpointId": {
                      "type": "string",
                      "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
                    },
                    "eventId": {
                      "type": "string"
                    },
                    "eventType": {
                      "type": "string",
                      "enum": [
                        "lead.captured",
                        "lead.abandoned",
                        "lead.converted",
                        "booking.created",
                        "booking.rescheduled",
                        "booking.cancelled",
                        "booking.confirmed_by_invitee",
                        "booking.expired",
                        "booking.completed"
                      ]
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "pending",
                        "delivering",
                        "succeeded",
                        "dead_letter"
                      ]
                    },
                    "attemptCount": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "nextAttemptAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                      "nullable": true
                    },
                    "waitingForEventId": {
                      "type": "string",
                      "nullable": true,
                      "description": "Unmet lead.captured event ID for a pending booking.created. Null once any original or replay capture delivery succeeds; optional on older releases."
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "completedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                      "nullable": true
                    },
                    "lastStatusCode": {
                      "type": "integer",
                      "nullable": true
                    },
                    "lastError": {
                      "type": "string",
                      "nullable": true
                    },
                    "replayId": {
                      "type": "string",
                      "nullable": true,
                      "description": "Explicit replay identity; null for an original delivery. Replays retain the original eventId and body."
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

GET /v1/webhook-deliveries/{deliveryId}

getWebhookDelivery

Required scopes: ["read:webhooks"]

Request and responses
{
  "operationId": "getWebhookDelivery",
  "tags": [
    "webhooks"
  ],
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^wd_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "deliveryId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:webhooks"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "endpointId",
              "eventId",
              "eventType",
              "status",
              "attemptCount",
              "nextAttemptAt",
              "createdAt",
              "completedAt",
              "lastStatusCode",
              "lastError",
              "replayId",
              "event",
              "attempts"
            ],
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^wd_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
              },
              "endpointId": {
                "type": "string",
                "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
              },
              "eventId": {
                "type": "string"
              },
              "eventType": {
                "type": "string",
                "enum": [
                  "lead.captured",
                  "lead.abandoned",
                  "lead.converted",
                  "booking.created",
                  "booking.rescheduled",
                  "booking.cancelled",
                  "booking.confirmed_by_invitee",
                  "booking.expired",
                  "booking.completed"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "delivering",
                  "succeeded",
                  "dead_letter"
                ]
              },
              "attemptCount": {
                "type": "integer",
                "minimum": 0
              },
              "nextAttemptAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                "nullable": true
              },
              "waitingForEventId": {
                "type": "string",
                "nullable": true,
                "description": "Unmet lead.captured event ID for a pending booking.created. Null once any original or replay capture delivery succeeds; optional on older releases."
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "completedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                "nullable": true
              },
              "lastStatusCode": {
                "type": "integer",
                "nullable": true
              },
              "lastError": {
                "type": "string",
                "nullable": true
              },
              "replayId": {
                "type": "string",
                "nullable": true,
                "description": "Explicit replay identity; null for an original delivery. Replays retain the original eventId and body."
              },
              "event": {
                "$ref": "#/components/schemas/WebhookEvent"
              },
              "attempts": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "attemptNumber",
                    "startedAt",
                    "completedAt",
                    "statusCode",
                    "error"
                  ],
                  "properties": {
                    "attemptNumber": {
                      "type": "integer",
                      "minimum": 1
                    },
                    "startedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "completedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                      "nullable": true
                    },
                    "statusCode": {
                      "type": "integer",
                      "nullable": true
                    },
                    "error": {
                      "type": "string",
                      "nullable": true
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

POST /v1/webhook-deliveries/{deliveryId}/replay

replayWebhookDelivery

Queues an explicit replay of a terminal delivery to an active endpoint, retaining the event_id and exact serialized body. Repeating the same Idempotency-Key reuses the replay. Pending or currently delivering entries return 409 webhook_delivery_pending. Paused endpoints return 409 webhook_endpoint_paused. Deleted endpoints return 404 not_found even though their delivery log remains readable.

Required scopes: ["write:webhooks"]

Request and responses
{
  "operationId": "replayWebhookDelivery",
  "tags": [
    "webhooks"
  ],
  "description": "Queues an explicit replay of a terminal delivery to an active endpoint, retaining the event_id and exact serialized body. Repeating the same Idempotency-Key reuses the replay. Pending or currently delivering entries return 409 webhook_delivery_pending. Paused endpoints return 409 webhook_endpoint_paused. Deleted endpoints return 404 not_found even though their delivery log remains readable.",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^wd_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "deliveryId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:webhooks"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "202": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "endpointId",
              "eventId",
              "eventType",
              "status",
              "attemptCount",
              "nextAttemptAt",
              "createdAt",
              "completedAt",
              "lastStatusCode",
              "lastError",
              "replayId"
            ],
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^wd_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
              },
              "endpointId": {
                "type": "string",
                "pattern": "^we_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
              },
              "eventId": {
                "type": "string"
              },
              "eventType": {
                "type": "string",
                "enum": [
                  "lead.captured",
                  "lead.abandoned",
                  "lead.converted",
                  "booking.created",
                  "booking.rescheduled",
                  "booking.cancelled",
                  "booking.confirmed_by_invitee",
                  "booking.expired",
                  "booking.completed"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "delivering",
                  "succeeded",
                  "dead_letter"
                ]
              },
              "attemptCount": {
                "type": "integer",
                "minimum": 0
              },
              "nextAttemptAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                "nullable": true
              },
              "waitingForEventId": {
                "type": "string",
                "nullable": true,
                "description": "Unmet lead.captured event ID for a pending booking.created. Null once any original or replay capture delivery succeeds; optional on older releases."
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "completedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                "nullable": true
              },
              "lastStatusCode": {
                "type": "integer",
                "nullable": true
              },
              "lastError": {
                "type": "string",
                "nullable": true
              },
              "replayId": {
                "type": "string",
                "nullable": true,
                "description": "Explicit replay identity; null for an original delivery. Replays retain the original eventId and body."
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/api-keys

listApiKeys

Owner/admin session required. API keys cannot access this operation.

Request and responses
{
  "operationId": "listApiKeys",
  "parameters": [
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 0,
        "maximum": 2147483647
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "session": []
    }
  ],
  "x-session-only": true,
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "name",
                    "prefix",
                    "scopes",
                    "createdAt",
                    "lastUsedAt",
                    "revokedAt"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^ak_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    },
                    "prefix": {
                      "type": "string",
                      "nullable": true
                    },
                    "scopes": {
                      "type": "array",
                      "minItems": 0,
                      "items": {
                        "type": "string",
                        "enum": [
                          "read:bookings",
                          "write:bookings",
                          "read:funnels",
                          "write:funnels",
                          "read:hosts",
                          "write:hosts",
                          "read:teams",
                          "write:teams",
                          "read:workspace-members",
                          "write:workspace-members",
                          "read:workspace-invitations",
                          "write:workspace-invitations",
                          "read:leads",
                          "write:leads",
                          "read:notification-preferences",
                          "write:notification-preferences",
                          "read:deliveries",
                          "write:deliveries",
                          "read:sequences",
                          "write:sequences",
                          "read:message-templates",
                          "write:message-templates",
                          "read:webhooks",
                          "write:webhooks"
                        ]
                      }
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "lastUsedAt": {
                      "type": "string",
                      "nullable": true
                    },
                    "revokedAt": {
                      "type": "string",
                      "nullable": true
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/api-keys

createApiKey

Owner/admin session required. API keys cannot access this operation.

Request and responses
{
  "operationId": "createApiKey",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name",
            "scopes"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "scopes": {
              "type": "array",
              "minItems": 1,
              "items": {
                "type": "string",
                "enum": [
                  "read:bookings",
                  "write:bookings",
                  "read:funnels",
                  "write:funnels",
                  "read:hosts",
                  "write:hosts",
                  "read:teams",
                  "write:teams",
                  "read:workspace-members",
                  "write:workspace-members",
                  "read:workspace-invitations",
                  "write:workspace-invitations",
                  "read:leads",
                  "write:leads",
                  "read:notification-preferences",
                  "write:notification-preferences",
                  "read:deliveries",
                  "write:deliveries",
                  "read:sequences",
                  "write:sequences",
                  "read:message-templates",
                  "write:message-templates",
                  "read:webhooks",
                  "write:webhooks"
                ]
              }
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "session": []
    }
  ],
  "x-session-only": true,
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "key",
              "apiKey"
            ],
            "properties": {
              "key": {
                "type": "string"
              },
              "apiKey": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "id",
                  "name",
                  "prefix",
                  "scopes",
                  "createdAt",
                  "lastUsedAt",
                  "revokedAt"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^ak_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "prefix": {
                    "type": "string",
                    "nullable": true
                  },
                  "scopes": {
                    "type": "array",
                    "minItems": 0,
                    "items": {
                      "type": "string",
                      "enum": [
                        "read:bookings",
                        "write:bookings",
                        "read:funnels",
                        "write:funnels",
                        "read:hosts",
                        "write:hosts",
                        "read:teams",
                        "write:teams",
                        "read:workspace-members",
                        "write:workspace-members",
                        "read:workspace-invitations",
                        "write:workspace-invitations",
                        "read:leads",
                        "write:leads",
                        "read:notification-preferences",
                        "write:notification-preferences",
                        "read:deliveries",
                        "write:deliveries",
                        "read:sequences",
                        "write:sequences",
                        "read:message-templates",
                        "write:message-templates",
                        "read:webhooks",
                        "write:webhooks"
                      ]
                    }
                  },
                  "createdAt": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "lastUsedAt": {
                    "type": "string",
                    "nullable": true
                  },
                  "revokedAt": {
                    "type": "string",
                    "nullable": true
                  }
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

DELETE /v1/api-keys/{keyId}

revokeApiKey

Owner/admin session required. API keys cannot access this operation.

Request and responses
{
  "operationId": "revokeApiKey",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^ak_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "keyId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "session": []
    }
  ],
  "x-session-only": true,
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "revokedAt"
            ],
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^ak_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
              },
              "revokedAt": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/deliveries

listDeliveries

Required scopes: ["read:deliveries"]

Request and responses
{
  "operationId": "listDeliveries",
  "parameters": [
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 25
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 0,
        "default": 0
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:deliveries"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "data",
              "total",
              "offset",
              "limit"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "bookingId",
                    "source",
                    "channel",
                    "flowName",
                    "stepId",
                    "createdAt",
                    "status",
                    "reason",
                    "content",
                    "contentExpired",
                    "canResend",
                    "events"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "bookingId": {
                      "type": "string"
                    },
                    "source": {
                      "type": "string",
                      "enum": [
                        "flow",
                        "reminder",
                        "system",
                        "resend"
                      ],
                      "description": "Incoming WhatsApp replies use flow for compatibility with existing clients; inspect direction to distinguish them from outgoing flow messages."
                    },
                    "channel": {
                      "type": "string",
                      "enum": [
                        "email",
                        "whatsapp"
                      ]
                    },
                    "direction": {
                      "type": "string",
                      "enum": [
                        "incoming",
                        "outgoing"
                      ],
                      "description": "Optional additive field; missing means outgoing. Incoming WhatsApp replies use source=flow and status=accepted for compatibility, meaning received rather than provider acceptance, and include a received event. They cannot be resent."
                    },
                    "automaticReply": {
                      "type": "boolean",
                      "description": "An automatic WhatsApp service reply; it cannot be manually resent."
                    },
                    "senderNumber": {
                      "type": "string",
                      "nullable": true,
                      "description": "The frozen WhatsApp business number: outgoing sender or incoming destination, never the invitee number. Independent of later number assignments."
                    },
                    "flowName": {
                      "type": "string",
                      "nullable": true
                    },
                    "stepId": {
                      "type": "string",
                      "nullable": true
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "pending",
                        "accepted",
                        "delivered",
                        "bounced",
                        "rejected",
                        "failed",
                        "unknown",
                        "skipped",
                        "cancelled"
                      ],
                      "description": "For incoming replies accepted means received, not accepted by a delivery provider. A provider read event retains overall delivered for compatibility; inspect events for read receipts."
                    },
                    "reason": {
                      "type": "string",
                      "nullable": true
                    },
                    "content": {
                      "type": "object",
                      "nullable": true,
                      "description": "Message content is available only to authorized owners/admins within retention. Incoming replies have an empty subject and redacted links; ambiguous replies are not exposed to workspaces.",
                      "required": [
                        "subject",
                        "text"
                      ],
                      "additionalProperties": false,
                      "properties": {
                        "subject": {
                          "type": "string"
                        },
                        "text": {
                          "type": "string"
                        }
                      }
                    },
                    "contentExpired": {
                      "type": "boolean"
                    },
                    "canResend": {
                      "type": "boolean"
                    },
                    "events": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "id",
                          "at",
                          "status",
                          "reason"
                        ],
                        "additionalProperties": false,
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "at": {
                            "type": "string",
                            "format": "date-time"
                          },
                          "status": {
                            "type": "string",
                            "description": "Delivery event status, including received for an incoming WhatsApp reply and read for a WhatsApp read receipt. Provider failure events use failed with reason=provider_failed."
                          },
                          "reason": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      }
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/bookings/{bookingId}/deliveries

listBookingDeliveries

Required scopes: ["read:deliveries"]

Request and responses
{
  "operationId": "listBookingDeliveries",
  "parameters": [
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 25
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 0,
        "default": 0
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "maxLength": 80
      },
      "in": "path",
      "name": "bookingId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:deliveries"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "data",
              "total",
              "offset",
              "limit"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "bookingId",
                    "source",
                    "channel",
                    "flowName",
                    "stepId",
                    "createdAt",
                    "status",
                    "reason",
                    "content",
                    "contentExpired",
                    "canResend",
                    "events"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "bookingId": {
                      "type": "string"
                    },
                    "source": {
                      "type": "string",
                      "enum": [
                        "flow",
                        "reminder",
                        "system",
                        "resend"
                      ],
                      "description": "Incoming WhatsApp replies use flow for compatibility with existing clients; inspect direction to distinguish them from outgoing flow messages."
                    },
                    "channel": {
                      "type": "string",
                      "enum": [
                        "email",
                        "whatsapp"
                      ]
                    },
                    "direction": {
                      "type": "string",
                      "enum": [
                        "incoming",
                        "outgoing"
                      ],
                      "description": "Optional additive field; missing means outgoing. Incoming WhatsApp replies use source=flow and status=accepted for compatibility, meaning received rather than provider acceptance, and include a received event. They cannot be resent."
                    },
                    "automaticReply": {
                      "type": "boolean",
                      "description": "An automatic WhatsApp service reply; it cannot be manually resent."
                    },
                    "senderNumber": {
                      "type": "string",
                      "nullable": true,
                      "description": "The frozen WhatsApp business number: outgoing sender or incoming destination, never the invitee number. Independent of later number assignments."
                    },
                    "flowName": {
                      "type": "string",
                      "nullable": true
                    },
                    "stepId": {
                      "type": "string",
                      "nullable": true
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "pending",
                        "accepted",
                        "delivered",
                        "bounced",
                        "rejected",
                        "failed",
                        "unknown",
                        "skipped",
                        "cancelled"
                      ],
                      "description": "For incoming replies accepted means received, not accepted by a delivery provider. A provider read event retains overall delivered for compatibility; inspect events for read receipts."
                    },
                    "reason": {
                      "type": "string",
                      "nullable": true
                    },
                    "content": {
                      "type": "object",
                      "nullable": true,
                      "description": "Message content is available only to authorized owners/admins within retention. Incoming replies have an empty subject and redacted links; ambiguous replies are not exposed to workspaces.",
                      "required": [
                        "subject",
                        "text"
                      ],
                      "additionalProperties": false,
                      "properties": {
                        "subject": {
                          "type": "string"
                        },
                        "text": {
                          "type": "string"
                        }
                      }
                    },
                    "contentExpired": {
                      "type": "boolean"
                    },
                    "canResend": {
                      "type": "boolean"
                    },
                    "events": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "id",
                          "at",
                          "status",
                          "reason"
                        ],
                        "additionalProperties": false,
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "at": {
                            "type": "string",
                            "format": "date-time"
                          },
                          "status": {
                            "type": "string",
                            "description": "Delivery event status, including received for an incoming WhatsApp reply and read for a WhatsApp read receipt. Provider failure events use failed with reason=provider_failed."
                          },
                          "reason": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      }
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/deliveries/{deliveryId}/resend

resendDelivery

Required scopes: ["write:deliveries"]

Request and responses
{
  "operationId": "resendDelivery",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^(flow|reminder|system):[a-zA-Z0-9_-]+$",
        "maxLength": 160
      },
      "in": "path",
      "name": "deliveryId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:deliveries"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "202": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "id"
            ],
            "properties": {
              "id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/sequences

listSequences

Required scopes: ["read:sequences"]

Request and responses
{
  "operationId": "listSequences",
  "parameters": [
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 25
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 0,
        "default": 0
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:sequences"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "data",
              "total",
              "limit",
              "offset",
              "canUseWhatsApp",
              "limits"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "workspaceId",
                    "name",
                    "draft",
                    "publishedVersionId",
                    "status",
                    "isDefault",
                    "usedByCount",
                    "createdAt",
                    "revision"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 160
                    },
                    "workspaceId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 160
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    "draft": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "schemaVersion",
                        "nodes"
                      ],
                      "properties": {
                        "schemaVersion": {
                          "type": "integer",
                          "enum": [
                            1
                          ]
                        },
                        "nodes": {
                          "type": "array",
                          "minItems": 1,
                          "items": {
                            "oneOf": [
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "id",
                                  "type",
                                  "trigger",
                                  "next"
                                ],
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "minLength": 1,
                                    "maxLength": 160
                                  },
                                  "type": {
                                    "type": "string",
                                    "enum": [
                                      "trigger"
                                    ]
                                  },
                                  "trigger": {
                                    "oneOf": [
                                      {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "kind"
                                        ],
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "enum": [
                                              "booking_created"
                                            ]
                                          }
                                        }
                                      },
                                      {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "kind"
                                        ],
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "enum": [
                                              "confirmation_pending"
                                            ]
                                          }
                                        }
                                      },
                                      {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "kind"
                                        ],
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "enum": [
                                              "after_booking_end"
                                            ]
                                          }
                                        }
                                      },
                                      {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "kind"
                                        ],
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "enum": [
                                              "booking_rescheduled"
                                            ]
                                          }
                                        }
                                      },
                                      {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "kind",
                                          "offsetSeconds"
                                        ],
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "enum": [
                                              "before_booking"
                                            ]
                                          },
                                          "offsetSeconds": {
                                            "type": "number",
                                            "minimum": 0,
                                            "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                                          }
                                        }
                                      }
                                    ]
                                  },
                                  "next": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "id",
                                  "type",
                                  "durationSeconds",
                                  "next"
                                ],
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "minLength": 1,
                                    "maxLength": 160
                                  },
                                  "type": {
                                    "type": "string",
                                    "enum": [
                                      "wait"
                                    ]
                                  },
                                  "durationSeconds": {
                                    "type": "number",
                                    "minimum": 0,
                                    "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                                  },
                                  "next": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "id",
                                  "type",
                                  "condition",
                                  "yes",
                                  "no"
                                ],
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "minLength": 1,
                                    "maxLength": 160
                                  },
                                  "type": {
                                    "type": "string",
                                    "enum": [
                                      "branch"
                                    ]
                                  },
                                  "condition": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "kind",
                                      "version"
                                    ],
                                    "properties": {
                                      "kind": {
                                        "type": "string",
                                        "enum": [
                                          "booking_confirmed"
                                        ]
                                      },
                                      "version": {
                                        "type": "integer",
                                        "enum": [
                                          1
                                        ]
                                      }
                                    }
                                  },
                                  "yes": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "no": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "id",
                                  "type",
                                  "content",
                                  "recipient",
                                  "next"
                                ],
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "minLength": 1,
                                    "maxLength": 160
                                  },
                                  "type": {
                                    "type": "string",
                                    "enum": [
                                      "email"
                                    ]
                                  },
                                  "content": {
                                    "oneOf": [
                                      {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "kind",
                                          "texts"
                                        ],
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "enum": [
                                              "reminder"
                                            ]
                                          },
                                          "texts": {
                                            "type": "object",
                                            "additionalProperties": false,
                                            "required": [
                                              "de",
                                              "en"
                                            ],
                                            "properties": {
                                              "de": {
                                                "type": "object",
                                                "additionalProperties": false,
                                                "required": [
                                                  "subject",
                                                  "subjectDate",
                                                  "title",
                                                  "greeting",
                                                  "reply",
                                                  "appointment",
                                                  "meeting",
                                                  "reschedule"
                                                ],
                                                "properties": {
                                                  "subject": {
                                                    "type": "string"
                                                  },
                                                  "subjectDate": {
                                                    "type": "string"
                                                  },
                                                  "title": {
                                                    "type": "string"
                                                  },
                                                  "greeting": {
                                                    "type": "string"
                                                  },
                                                  "reply": {
                                                    "type": "string"
                                                  },
                                                  "appointment": {
                                                    "type": "string"
                                                  },
                                                  "meeting": {
                                                    "type": "string"
                                                  },
                                                  "reschedule": {
                                                    "type": "string"
                                                  }
                                                }
                                              },
                                              "en": {
                                                "type": "object",
                                                "additionalProperties": false,
                                                "required": [
                                                  "subject",
                                                  "subjectDate",
                                                  "title",
                                                  "greeting",
                                                  "reply",
                                                  "appointment",
                                                  "meeting",
                                                  "reschedule"
                                                ],
                                                "properties": {
                                                  "subject": {
                                                    "type": "string"
                                                  },
                                                  "subjectDate": {
                                                    "type": "string"
                                                  },
                                                  "title": {
                                                    "type": "string"
                                                  },
                                                  "greeting": {
                                                    "type": "string"
                                                  },
                                                  "reply": {
                                                    "type": "string"
                                                  },
                                                  "appointment": {
                                                    "type": "string"
                                                  },
                                                  "meeting": {
                                                    "type": "string"
                                                  },
                                                  "reschedule": {
                                                    "type": "string"
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      },
                                      {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "kind",
                                          "locales"
                                        ],
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "enum": [
                                              "email"
                                            ]
                                          },
                                          "locales": {
                                            "type": "object",
                                            "additionalProperties": false,
                                            "required": [
                                              "de",
                                              "en"
                                            ],
                                            "properties": {
                                              "de": {
                                                "type": "object",
                                                "additionalProperties": false,
                                                "required": [
                                                  "subject",
                                                  "text",
                                                  "html"
                                                ],
                                                "properties": {
                                                  "subject": {
                                                    "type": "string"
                                                  },
                                                  "text": {
                                                    "type": "string"
                                                  },
                                                  "html": {
                                                    "type": "string"
                                                  }
                                                }
                                              },
                                              "en": {
                                                "type": "object",
                                                "additionalProperties": false,
                                                "required": [
                                                  "subject",
                                                  "text",
                                                  "html"
                                                ],
                                                "properties": {
                                                  "subject": {
                                                    "type": "string"
                                                  },
                                                  "text": {
                                                    "type": "string"
                                                  },
                                                  "html": {
                                                    "type": "string"
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      }
                                    ]
                                  },
                                  "recipient": {
                                    "type": "string",
                                    "enum": [
                                      "invitee",
                                      "host"
                                    ]
                                  },
                                  "next": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "id",
                                  "type",
                                  "content",
                                  "recipient",
                                  "recipientEmail",
                                  "next"
                                ],
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "minLength": 1,
                                    "maxLength": 160
                                  },
                                  "type": {
                                    "type": "string",
                                    "enum": [
                                      "email"
                                    ]
                                  },
                                  "content": {
                                    "oneOf": [
                                      {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "kind",
                                          "texts"
                                        ],
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "enum": [
                                              "reminder"
                                            ]
                                          },
                                          "texts": {
                                            "type": "object",
                                            "additionalProperties": false,
                                            "required": [
                                              "de",
                                              "en"
                                            ],
                                            "properties": {
                                              "de": {
                                                "type": "object",
                                                "additionalProperties": false,
                                                "required": [
                                                  "subject",
                                                  "subjectDate",
                                                  "title",
                                                  "greeting",
                                                  "reply",
                                                  "appointment",
                                                  "meeting",
                                                  "reschedule"
                                                ],
                                                "properties": {
                                                  "subject": {
                                                    "type": "string"
                                                  },
                                                  "subjectDate": {
                                                    "type": "string"
                                                  },
                                                  "title": {
                                                    "type": "string"
                                                  },
                                                  "greeting": {
                                                    "type": "string"
                                                  },
                                                  "reply": {
                                                    "type": "string"
                                                  },
                                                  "appointment": {
                                                    "type": "string"
                                                  },
                                                  "meeting": {
                                                    "type": "string"
                                                  },
                                                  "reschedule": {
                                                    "type": "string"
                                                  }
                                                }
                                              },
                                              "en": {
                                                "type": "object",
                                                "additionalProperties": false,
                                                "required": [
                                                  "subject",
                                                  "subjectDate",
                                                  "title",
                                                  "greeting",
                                                  "reply",
                                                  "appointment",
                                                  "meeting",
                                                  "reschedule"
                                                ],
                                                "properties": {
                                                  "subject": {
                                                    "type": "string"
                                                  },
                                                  "subjectDate": {
                                                    "type": "string"
                                                  },
                                                  "title": {
                                                    "type": "string"
                                                  },
                                                  "greeting": {
                                                    "type": "string"
                                                  },
                                                  "reply": {
                                                    "type": "string"
                                                  },
                                                  "appointment": {
                                                    "type": "string"
                                                  },
                                                  "meeting": {
                                                    "type": "string"
                                                  },
                                                  "reschedule": {
                                                    "type": "string"
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      },
                                      {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "kind",
                                          "locales"
                                        ],
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "enum": [
                                              "email"
                                            ]
                                          },
                                          "locales": {
                                            "type": "object",
                                            "additionalProperties": false,
                                            "required": [
                                              "de",
                                              "en"
                                            ],
                                            "properties": {
                                              "de": {
                                                "type": "object",
                                                "additionalProperties": false,
                                                "required": [
                                                  "subject",
                                                  "text",
                                                  "html"
                                                ],
                                                "properties": {
                                                  "subject": {
                                                    "type": "string"
                                                  },
                                                  "text": {
                                                    "type": "string"
                                                  },
                                                  "html": {
                                                    "type": "string"
                                                  }
                                                }
                                              },
                                              "en": {
                                                "type": "object",
                                                "additionalProperties": false,
                                                "required": [
                                                  "subject",
                                                  "text",
                                                  "html"
                                                ],
                                                "properties": {
                                                  "subject": {
                                                    "type": "string"
                                                  },
                                                  "text": {
                                                    "type": "string"
                                                  },
                                                  "html": {
                                                    "type": "string"
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      }
                                    ]
                                  },
                                  "recipient": {
                                    "type": "string",
                                    "enum": [
                                      "specific_email"
                                    ]
                                  },
                                  "recipientEmail": {
                                    "type": "string"
                                  },
                                  "recipientEmails": {
                                    "type": "array",
                                    "items": {
                                      "type": "string"
                                    }
                                  },
                                  "next": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "id",
                                  "type",
                                  "templateVersionId",
                                  "recipient",
                                  "recipientEmail",
                                  "next"
                                ],
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "minLength": 1,
                                    "maxLength": 160
                                  },
                                  "type": {
                                    "type": "string",
                                    "enum": [
                                      "email"
                                    ]
                                  },
                                  "templateVersionId": {
                                    "type": "string",
                                    "minLength": 1,
                                    "maxLength": 160
                                  },
                                  "recipient": {
                                    "type": "string",
                                    "enum": [
                                      "specific_email"
                                    ]
                                  },
                                  "recipientEmail": {
                                    "type": "string"
                                  },
                                  "recipientEmails": {
                                    "type": "array",
                                    "items": {
                                      "type": "string"
                                    }
                                  },
                                  "next": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "id",
                                  "type",
                                  "templateVersionId",
                                  "recipient",
                                  "next"
                                ],
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "minLength": 1,
                                    "maxLength": 160
                                  },
                                  "type": {
                                    "type": "string",
                                    "enum": [
                                      "email",
                                      "whatsapp"
                                    ]
                                  },
                                  "templateVersionId": {
                                    "type": "string",
                                    "minLength": 1,
                                    "maxLength": 160
                                  },
                                  "recipient": {
                                    "type": "string",
                                    "enum": [
                                      "invitee",
                                      "host"
                                    ]
                                  },
                                  "next": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    },
                    "labels": {
                      "type": "array",
                      "maxItems": 3,
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "name",
                          "color"
                        ],
                        "properties": {
                          "name": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 32
                          },
                          "color": {
                            "type": "string",
                            "enum": [
                              "blue",
                              "cyan",
                              "green",
                              "orange",
                              "pink",
                              "purple",
                              "gray"
                            ]
                          }
                        }
                      }
                    },
                    "emailContents": {
                      "type": "object",
                      "additionalProperties": {
                        "oneOf": [
                          {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "kind",
                              "texts"
                            ],
                            "properties": {
                              "kind": {
                                "type": "string",
                                "enum": [
                                  "reminder"
                                ]
                              },
                              "texts": {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "de",
                                  "en"
                                ],
                                "properties": {
                                  "de": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "subject",
                                      "subjectDate",
                                      "title",
                                      "greeting",
                                      "reply",
                                      "appointment",
                                      "meeting",
                                      "reschedule"
                                    ],
                                    "properties": {
                                      "subject": {
                                        "type": "string"
                                      },
                                      "subjectDate": {
                                        "type": "string"
                                      },
                                      "title": {
                                        "type": "string"
                                      },
                                      "greeting": {
                                        "type": "string"
                                      },
                                      "reply": {
                                        "type": "string"
                                      },
                                      "appointment": {
                                        "type": "string"
                                      },
                                      "meeting": {
                                        "type": "string"
                                      },
                                      "reschedule": {
                                        "type": "string"
                                      }
                                    }
                                  },
                                  "en": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "subject",
                                      "subjectDate",
                                      "title",
                                      "greeting",
                                      "reply",
                                      "appointment",
                                      "meeting",
                                      "reschedule"
                                    ],
                                    "properties": {
                                      "subject": {
                                        "type": "string"
                                      },
                                      "subjectDate": {
                                        "type": "string"
                                      },
                                      "title": {
                                        "type": "string"
                                      },
                                      "greeting": {
                                        "type": "string"
                                      },
                                      "reply": {
                                        "type": "string"
                                      },
                                      "appointment": {
                                        "type": "string"
                                      },
                                      "meeting": {
                                        "type": "string"
                                      },
                                      "reschedule": {
                                        "type": "string"
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          },
                          {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "kind",
                              "locales"
                            ],
                            "properties": {
                              "kind": {
                                "type": "string",
                                "enum": [
                                  "email"
                                ]
                              },
                              "locales": {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "de",
                                  "en"
                                ],
                                "properties": {
                                  "de": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "subject",
                                      "text",
                                      "html"
                                    ],
                                    "properties": {
                                      "subject": {
                                        "type": "string"
                                      },
                                      "text": {
                                        "type": "string"
                                      },
                                      "html": {
                                        "type": "string"
                                      }
                                    }
                                  },
                                  "en": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "subject",
                                      "text",
                                      "html"
                                    ],
                                    "properties": {
                                      "subject": {
                                        "type": "string"
                                      },
                                      "text": {
                                        "type": "string"
                                      },
                                      "html": {
                                        "type": "string"
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        ]
                      }
                    },
                    "publishedVersionId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 160,
                      "nullable": true
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "draft",
                        "published"
                      ]
                    },
                    "isDefault": {
                      "type": "boolean"
                    },
                    "usedByCount": {
                      "type": "integer"
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "revision": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 128
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              },
              "canUseWhatsApp": {
                "type": "boolean"
              },
              "limits": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "maxNodes",
                  "maxDurationSeconds",
                  "maxFlowsPerFunnel"
                ],
                "properties": {
                  "maxNodes": {
                    "type": "integer"
                  },
                  "maxRecipientsPerEmail": {
                    "type": "integer"
                  },
                  "dailyEmailLimit": {
                    "type": "integer"
                  },
                  "maxDurationSeconds": {
                    "type": "number"
                  },
                  "maxFlowsPerFunnel": {
                    "type": "integer"
                  },
                  "extendedTriggersEnabled": {
                    "type": "boolean"
                  },
                  "editableEmailsEnabled": {
                    "type": "boolean"
                  },
                  "specificEmailRecipientEnabled": {
                    "type": "boolean"
                  },
                  "multipleEmailRecipientsEnabled": {
                    "type": "boolean"
                  }
                }
              },
              "defaultReminderTrigger": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "booking_created"
                        ]
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "confirmation_pending"
                        ]
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "after_booking_end"
                        ]
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "booking_rescheduled"
                        ]
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "offsetSeconds"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "before_booking"
                        ]
                      },
                      "offsetSeconds": {
                        "type": "number",
                        "minimum": 0,
                        "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/sequences

createSequence

Required scopes: ["write:sequences"]

Request and responses
{
  "operationId": "createSequence",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name",
            "draft"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "draft": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "schemaVersion",
                "nodes"
              ],
              "properties": {
                "schemaVersion": {
                  "type": "integer",
                  "enum": [
                    1
                  ]
                },
                "nodes": {
                  "type": "array",
                  "minItems": 1,
                  "items": {
                    "oneOf": [
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "trigger",
                          "next"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "trigger"
                            ]
                          },
                          "trigger": {
                            "oneOf": [
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "booking_created"
                                    ]
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "confirmation_pending"
                                    ]
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "after_booking_end"
                                    ]
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "booking_rescheduled"
                                    ]
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind",
                                  "offsetSeconds"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "before_booking"
                                    ]
                                  },
                                  "offsetSeconds": {
                                    "type": "number",
                                    "minimum": 0,
                                    "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                                  }
                                }
                              }
                            ]
                          },
                          "next": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      },
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "durationSeconds",
                          "next"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "wait"
                            ]
                          },
                          "durationSeconds": {
                            "type": "number",
                            "minimum": 0,
                            "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                          },
                          "next": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      },
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "condition",
                          "yes",
                          "no"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "branch"
                            ]
                          },
                          "condition": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "kind",
                              "version"
                            ],
                            "properties": {
                              "kind": {
                                "type": "string",
                                "enum": [
                                  "booking_confirmed"
                                ]
                              },
                              "version": {
                                "type": "integer",
                                "enum": [
                                  1
                                ]
                              }
                            }
                          },
                          "yes": {
                            "type": "string",
                            "nullable": true
                          },
                          "no": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      },
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "content",
                          "recipient",
                          "next"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "email"
                            ]
                          },
                          "content": {
                            "oneOf": [
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind",
                                  "texts"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "reminder"
                                    ]
                                  },
                                  "texts": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "de",
                                      "en"
                                    ],
                                    "properties": {
                                      "de": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "subjectDate",
                                          "title",
                                          "greeting",
                                          "reply",
                                          "appointment",
                                          "meeting",
                                          "reschedule"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "subjectDate": {
                                            "type": "string"
                                          },
                                          "title": {
                                            "type": "string"
                                          },
                                          "greeting": {
                                            "type": "string"
                                          },
                                          "reply": {
                                            "type": "string"
                                          },
                                          "appointment": {
                                            "type": "string"
                                          },
                                          "meeting": {
                                            "type": "string"
                                          },
                                          "reschedule": {
                                            "type": "string"
                                          }
                                        }
                                      },
                                      "en": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "subjectDate",
                                          "title",
                                          "greeting",
                                          "reply",
                                          "appointment",
                                          "meeting",
                                          "reschedule"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "subjectDate": {
                                            "type": "string"
                                          },
                                          "title": {
                                            "type": "string"
                                          },
                                          "greeting": {
                                            "type": "string"
                                          },
                                          "reply": {
                                            "type": "string"
                                          },
                                          "appointment": {
                                            "type": "string"
                                          },
                                          "meeting": {
                                            "type": "string"
                                          },
                                          "reschedule": {
                                            "type": "string"
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind",
                                  "locales"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "email"
                                    ]
                                  },
                                  "locales": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "de",
                                      "en"
                                    ],
                                    "properties": {
                                      "de": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "text",
                                          "html"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "text": {
                                            "type": "string"
                                          },
                                          "html": {
                                            "type": "string"
                                          }
                                        }
                                      },
                                      "en": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "text",
                                          "html"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "text": {
                                            "type": "string"
                                          },
                                          "html": {
                                            "type": "string"
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          },
                          "recipient": {
                            "type": "string",
                            "enum": [
                              "invitee",
                              "host"
                            ]
                          },
                          "next": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      },
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "content",
                          "recipient",
                          "recipientEmail",
                          "next"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "email"
                            ]
                          },
                          "content": {
                            "oneOf": [
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind",
                                  "texts"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "reminder"
                                    ]
                                  },
                                  "texts": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "de",
                                      "en"
                                    ],
                                    "properties": {
                                      "de": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "subjectDate",
                                          "title",
                                          "greeting",
                                          "reply",
                                          "appointment",
                                          "meeting",
                                          "reschedule"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "subjectDate": {
                                            "type": "string"
                                          },
                                          "title": {
                                            "type": "string"
                                          },
                                          "greeting": {
                                            "type": "string"
                                          },
                                          "reply": {
                                            "type": "string"
                                          },
                                          "appointment": {
                                            "type": "string"
                                          },
                                          "meeting": {
                                            "type": "string"
                                          },
                                          "reschedule": {
                                            "type": "string"
                                          }
                                        }
                                      },
                                      "en": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "subjectDate",
                                          "title",
                                          "greeting",
                                          "reply",
                                          "appointment",
                                          "meeting",
                                          "reschedule"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "subjectDate": {
                                            "type": "string"
                                          },
                                          "title": {
                                            "type": "string"
                                          },
                                          "greeting": {
                                            "type": "string"
                                          },
                                          "reply": {
                                            "type": "string"
                                          },
                                          "appointment": {
                                            "type": "string"
                                          },
                                          "meeting": {
                                            "type": "string"
                                          },
                                          "reschedule": {
                                            "type": "string"
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind",
                                  "locales"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "email"
                                    ]
                                  },
                                  "locales": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "de",
                                      "en"
                                    ],
                                    "properties": {
                                      "de": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "text",
                                          "html"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "text": {
                                            "type": "string"
                                          },
                                          "html": {
                                            "type": "string"
                                          }
                                        }
                                      },
                                      "en": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "text",
                                          "html"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "text": {
                                            "type": "string"
                                          },
                                          "html": {
                                            "type": "string"
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          },
                          "recipient": {
                            "type": "string",
                            "enum": [
                              "specific_email"
                            ]
                          },
                          "recipientEmail": {
                            "type": "string"
                          },
                          "recipientEmails": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "next": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      },
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "templateVersionId",
                          "recipient",
                          "recipientEmail",
                          "next"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "email"
                            ]
                          },
                          "templateVersionId": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "recipient": {
                            "type": "string",
                            "enum": [
                              "specific_email"
                            ]
                          },
                          "recipientEmail": {
                            "type": "string"
                          },
                          "recipientEmails": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "next": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      },
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "templateVersionId",
                          "recipient",
                          "next"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "email",
                              "whatsapp"
                            ]
                          },
                          "templateVersionId": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "recipient": {
                            "type": "string",
                            "enum": [
                              "invitee",
                              "host"
                            ]
                          },
                          "next": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:sequences"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "draft",
              "publishedVersionId",
              "status",
              "isDefault",
              "usedByCount",
              "createdAt",
              "revision"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "draft": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "schemaVersion",
                  "nodes"
                ],
                "properties": {
                  "schemaVersion": {
                    "type": "integer",
                    "enum": [
                      1
                    ]
                  },
                  "nodes": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "oneOf": [
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "trigger",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "trigger"
                              ]
                            },
                            "trigger": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "booking_created"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "confirmation_pending"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "after_booking_end"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "booking_rescheduled"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "offsetSeconds"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "before_booking"
                                      ]
                                    },
                                    "offsetSeconds": {
                                      "type": "number",
                                      "minimum": 0,
                                      "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                                    }
                                  }
                                }
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "durationSeconds",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "wait"
                              ]
                            },
                            "durationSeconds": {
                              "type": "number",
                              "minimum": 0,
                              "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "condition",
                            "yes",
                            "no"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "branch"
                              ]
                            },
                            "condition": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "kind",
                                "version"
                              ],
                              "properties": {
                                "kind": {
                                  "type": "string",
                                  "enum": [
                                    "booking_confirmed"
                                  ]
                                },
                                "version": {
                                  "type": "integer",
                                  "enum": [
                                    1
                                  ]
                                }
                              }
                            },
                            "yes": {
                              "type": "string",
                              "nullable": true
                            },
                            "no": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "content",
                            "recipient",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "content": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "texts"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "reminder"
                                      ]
                                    },
                                    "texts": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "locales"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "email"
                                      ]
                                    },
                                    "locales": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "invitee",
                                "host"
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "content",
                            "recipient",
                            "recipientEmail",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "content": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "texts"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "reminder"
                                      ]
                                    },
                                    "texts": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "locales"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "email"
                                      ]
                                    },
                                    "locales": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "specific_email"
                              ]
                            },
                            "recipientEmail": {
                              "type": "string"
                            },
                            "recipientEmails": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "templateVersionId",
                            "recipient",
                            "recipientEmail",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "templateVersionId": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "specific_email"
                              ]
                            },
                            "recipientEmail": {
                              "type": "string"
                            },
                            "recipientEmails": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "templateVersionId",
                            "recipient",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email",
                                "whatsapp"
                              ]
                            },
                            "templateVersionId": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "invitee",
                                "host"
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              },
              "labels": {
                "type": "array",
                "maxItems": 3,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "color"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32
                    },
                    "color": {
                      "type": "string",
                      "enum": [
                        "blue",
                        "cyan",
                        "green",
                        "orange",
                        "pink",
                        "purple",
                        "gray"
                      ]
                    }
                  }
                }
              },
              "emailContents": {
                "type": "object",
                "additionalProperties": {
                  "oneOf": [
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "kind",
                        "texts"
                      ],
                      "properties": {
                        "kind": {
                          "type": "string",
                          "enum": [
                            "reminder"
                          ]
                        },
                        "texts": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "subjectDate",
                                "title",
                                "greeting",
                                "reply",
                                "appointment",
                                "meeting",
                                "reschedule"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "subjectDate": {
                                  "type": "string"
                                },
                                "title": {
                                  "type": "string"
                                },
                                "greeting": {
                                  "type": "string"
                                },
                                "reply": {
                                  "type": "string"
                                },
                                "appointment": {
                                  "type": "string"
                                },
                                "meeting": {
                                  "type": "string"
                                },
                                "reschedule": {
                                  "type": "string"
                                }
                              }
                            },
                            "en": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "subjectDate",
                                "title",
                                "greeting",
                                "reply",
                                "appointment",
                                "meeting",
                                "reschedule"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "subjectDate": {
                                  "type": "string"
                                },
                                "title": {
                                  "type": "string"
                                },
                                "greeting": {
                                  "type": "string"
                                },
                                "reply": {
                                  "type": "string"
                                },
                                "appointment": {
                                  "type": "string"
                                },
                                "meeting": {
                                  "type": "string"
                                },
                                "reschedule": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "kind",
                        "locales"
                      ],
                      "properties": {
                        "kind": {
                          "type": "string",
                          "enum": [
                            "email"
                          ]
                        },
                        "locales": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "text",
                                "html"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "text": {
                                  "type": "string"
                                },
                                "html": {
                                  "type": "string"
                                }
                              }
                            },
                            "en": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "text",
                                "html"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "text": {
                                  "type": "string"
                                },
                                "html": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              },
              "publishedVersionId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160,
                "nullable": true
              },
              "status": {
                "type": "string",
                "enum": [
                  "draft",
                  "published"
                ]
              },
              "isDefault": {
                "type": "boolean"
              },
              "usedByCount": {
                "type": "integer"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              },
              "revision": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/sequences/{sequenceId}

getSequence

Required scopes: ["read:sequences"]

Request and responses
{
  "operationId": "getSequence",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "sequenceId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:sequences"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "draft",
              "publishedVersionId",
              "status",
              "isDefault",
              "usedByCount",
              "createdAt",
              "revision"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "draft": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "schemaVersion",
                  "nodes"
                ],
                "properties": {
                  "schemaVersion": {
                    "type": "integer",
                    "enum": [
                      1
                    ]
                  },
                  "nodes": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "oneOf": [
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "trigger",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "trigger"
                              ]
                            },
                            "trigger": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "booking_created"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "confirmation_pending"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "after_booking_end"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "booking_rescheduled"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "offsetSeconds"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "before_booking"
                                      ]
                                    },
                                    "offsetSeconds": {
                                      "type": "number",
                                      "minimum": 0,
                                      "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                                    }
                                  }
                                }
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "durationSeconds",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "wait"
                              ]
                            },
                            "durationSeconds": {
                              "type": "number",
                              "minimum": 0,
                              "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "condition",
                            "yes",
                            "no"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "branch"
                              ]
                            },
                            "condition": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "kind",
                                "version"
                              ],
                              "properties": {
                                "kind": {
                                  "type": "string",
                                  "enum": [
                                    "booking_confirmed"
                                  ]
                                },
                                "version": {
                                  "type": "integer",
                                  "enum": [
                                    1
                                  ]
                                }
                              }
                            },
                            "yes": {
                              "type": "string",
                              "nullable": true
                            },
                            "no": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "content",
                            "recipient",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "content": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "texts"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "reminder"
                                      ]
                                    },
                                    "texts": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "locales"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "email"
                                      ]
                                    },
                                    "locales": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "invitee",
                                "host"
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "content",
                            "recipient",
                            "recipientEmail",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "content": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "texts"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "reminder"
                                      ]
                                    },
                                    "texts": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "locales"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "email"
                                      ]
                                    },
                                    "locales": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "specific_email"
                              ]
                            },
                            "recipientEmail": {
                              "type": "string"
                            },
                            "recipientEmails": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "templateVersionId",
                            "recipient",
                            "recipientEmail",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "templateVersionId": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "specific_email"
                              ]
                            },
                            "recipientEmail": {
                              "type": "string"
                            },
                            "recipientEmails": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "templateVersionId",
                            "recipient",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email",
                                "whatsapp"
                              ]
                            },
                            "templateVersionId": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "invitee",
                                "host"
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              },
              "labels": {
                "type": "array",
                "maxItems": 3,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "color"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32
                    },
                    "color": {
                      "type": "string",
                      "enum": [
                        "blue",
                        "cyan",
                        "green",
                        "orange",
                        "pink",
                        "purple",
                        "gray"
                      ]
                    }
                  }
                }
              },
              "emailContents": {
                "type": "object",
                "additionalProperties": {
                  "oneOf": [
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "kind",
                        "texts"
                      ],
                      "properties": {
                        "kind": {
                          "type": "string",
                          "enum": [
                            "reminder"
                          ]
                        },
                        "texts": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "subjectDate",
                                "title",
                                "greeting",
                                "reply",
                                "appointment",
                                "meeting",
                                "reschedule"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "subjectDate": {
                                  "type": "string"
                                },
                                "title": {
                                  "type": "string"
                                },
                                "greeting": {
                                  "type": "string"
                                },
                                "reply": {
                                  "type": "string"
                                },
                                "appointment": {
                                  "type": "string"
                                },
                                "meeting": {
                                  "type": "string"
                                },
                                "reschedule": {
                                  "type": "string"
                                }
                              }
                            },
                            "en": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "subjectDate",
                                "title",
                                "greeting",
                                "reply",
                                "appointment",
                                "meeting",
                                "reschedule"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "subjectDate": {
                                  "type": "string"
                                },
                                "title": {
                                  "type": "string"
                                },
                                "greeting": {
                                  "type": "string"
                                },
                                "reply": {
                                  "type": "string"
                                },
                                "appointment": {
                                  "type": "string"
                                },
                                "meeting": {
                                  "type": "string"
                                },
                                "reschedule": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "kind",
                        "locales"
                      ],
                      "properties": {
                        "kind": {
                          "type": "string",
                          "enum": [
                            "email"
                          ]
                        },
                        "locales": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "text",
                                "html"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "text": {
                                  "type": "string"
                                },
                                "html": {
                                  "type": "string"
                                }
                              }
                            },
                            "en": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "text",
                                "html"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "text": {
                                  "type": "string"
                                },
                                "html": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              },
              "publishedVersionId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160,
                "nullable": true
              },
              "status": {
                "type": "string",
                "enum": [
                  "draft",
                  "published"
                ]
              },
              "isDefault": {
                "type": "boolean"
              },
              "usedByCount": {
                "type": "integer"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              },
              "revision": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

PUT /v1/sequences/{sequenceId}

updateSequence

Required scopes: ["write:sequences"]

Request and responses
{
  "operationId": "updateSequence",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "expectedRevision"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "draft": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "schemaVersion",
                "nodes"
              ],
              "properties": {
                "schemaVersion": {
                  "type": "integer",
                  "enum": [
                    1
                  ]
                },
                "nodes": {
                  "type": "array",
                  "minItems": 1,
                  "items": {
                    "oneOf": [
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "trigger",
                          "next"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "trigger"
                            ]
                          },
                          "trigger": {
                            "oneOf": [
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "booking_created"
                                    ]
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "confirmation_pending"
                                    ]
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "after_booking_end"
                                    ]
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "booking_rescheduled"
                                    ]
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind",
                                  "offsetSeconds"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "before_booking"
                                    ]
                                  },
                                  "offsetSeconds": {
                                    "type": "number",
                                    "minimum": 0,
                                    "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                                  }
                                }
                              }
                            ]
                          },
                          "next": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      },
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "durationSeconds",
                          "next"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "wait"
                            ]
                          },
                          "durationSeconds": {
                            "type": "number",
                            "minimum": 0,
                            "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                          },
                          "next": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      },
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "condition",
                          "yes",
                          "no"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "branch"
                            ]
                          },
                          "condition": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "kind",
                              "version"
                            ],
                            "properties": {
                              "kind": {
                                "type": "string",
                                "enum": [
                                  "booking_confirmed"
                                ]
                              },
                              "version": {
                                "type": "integer",
                                "enum": [
                                  1
                                ]
                              }
                            }
                          },
                          "yes": {
                            "type": "string",
                            "nullable": true
                          },
                          "no": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      },
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "content",
                          "recipient",
                          "next"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "email"
                            ]
                          },
                          "content": {
                            "oneOf": [
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind",
                                  "texts"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "reminder"
                                    ]
                                  },
                                  "texts": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "de",
                                      "en"
                                    ],
                                    "properties": {
                                      "de": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "subjectDate",
                                          "title",
                                          "greeting",
                                          "reply",
                                          "appointment",
                                          "meeting",
                                          "reschedule"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "subjectDate": {
                                            "type": "string"
                                          },
                                          "title": {
                                            "type": "string"
                                          },
                                          "greeting": {
                                            "type": "string"
                                          },
                                          "reply": {
                                            "type": "string"
                                          },
                                          "appointment": {
                                            "type": "string"
                                          },
                                          "meeting": {
                                            "type": "string"
                                          },
                                          "reschedule": {
                                            "type": "string"
                                          }
                                        }
                                      },
                                      "en": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "subjectDate",
                                          "title",
                                          "greeting",
                                          "reply",
                                          "appointment",
                                          "meeting",
                                          "reschedule"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "subjectDate": {
                                            "type": "string"
                                          },
                                          "title": {
                                            "type": "string"
                                          },
                                          "greeting": {
                                            "type": "string"
                                          },
                                          "reply": {
                                            "type": "string"
                                          },
                                          "appointment": {
                                            "type": "string"
                                          },
                                          "meeting": {
                                            "type": "string"
                                          },
                                          "reschedule": {
                                            "type": "string"
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind",
                                  "locales"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "email"
                                    ]
                                  },
                                  "locales": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "de",
                                      "en"
                                    ],
                                    "properties": {
                                      "de": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "text",
                                          "html"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "text": {
                                            "type": "string"
                                          },
                                          "html": {
                                            "type": "string"
                                          }
                                        }
                                      },
                                      "en": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "text",
                                          "html"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "text": {
                                            "type": "string"
                                          },
                                          "html": {
                                            "type": "string"
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          },
                          "recipient": {
                            "type": "string",
                            "enum": [
                              "invitee",
                              "host"
                            ]
                          },
                          "next": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      },
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "content",
                          "recipient",
                          "recipientEmail",
                          "next"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "email"
                            ]
                          },
                          "content": {
                            "oneOf": [
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind",
                                  "texts"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "reminder"
                                    ]
                                  },
                                  "texts": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "de",
                                      "en"
                                    ],
                                    "properties": {
                                      "de": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "subjectDate",
                                          "title",
                                          "greeting",
                                          "reply",
                                          "appointment",
                                          "meeting",
                                          "reschedule"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "subjectDate": {
                                            "type": "string"
                                          },
                                          "title": {
                                            "type": "string"
                                          },
                                          "greeting": {
                                            "type": "string"
                                          },
                                          "reply": {
                                            "type": "string"
                                          },
                                          "appointment": {
                                            "type": "string"
                                          },
                                          "meeting": {
                                            "type": "string"
                                          },
                                          "reschedule": {
                                            "type": "string"
                                          }
                                        }
                                      },
                                      "en": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "subjectDate",
                                          "title",
                                          "greeting",
                                          "reply",
                                          "appointment",
                                          "meeting",
                                          "reschedule"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "subjectDate": {
                                            "type": "string"
                                          },
                                          "title": {
                                            "type": "string"
                                          },
                                          "greeting": {
                                            "type": "string"
                                          },
                                          "reply": {
                                            "type": "string"
                                          },
                                          "appointment": {
                                            "type": "string"
                                          },
                                          "meeting": {
                                            "type": "string"
                                          },
                                          "reschedule": {
                                            "type": "string"
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "kind",
                                  "locales"
                                ],
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "email"
                                    ]
                                  },
                                  "locales": {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "de",
                                      "en"
                                    ],
                                    "properties": {
                                      "de": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "text",
                                          "html"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "text": {
                                            "type": "string"
                                          },
                                          "html": {
                                            "type": "string"
                                          }
                                        }
                                      },
                                      "en": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "required": [
                                          "subject",
                                          "text",
                                          "html"
                                        ],
                                        "properties": {
                                          "subject": {
                                            "type": "string"
                                          },
                                          "text": {
                                            "type": "string"
                                          },
                                          "html": {
                                            "type": "string"
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          },
                          "recipient": {
                            "type": "string",
                            "enum": [
                              "specific_email"
                            ]
                          },
                          "recipientEmail": {
                            "type": "string"
                          },
                          "recipientEmails": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "next": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      },
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "templateVersionId",
                          "recipient",
                          "recipientEmail",
                          "next"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "email"
                            ]
                          },
                          "templateVersionId": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "recipient": {
                            "type": "string",
                            "enum": [
                              "specific_email"
                            ]
                          },
                          "recipientEmail": {
                            "type": "string"
                          },
                          "recipientEmails": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "next": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      },
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "templateVersionId",
                          "recipient",
                          "next"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "email",
                              "whatsapp"
                            ]
                          },
                          "templateVersionId": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 160
                          },
                          "recipient": {
                            "type": "string",
                            "enum": [
                              "invitee",
                              "host"
                            ]
                          },
                          "next": {
                            "type": "string",
                            "nullable": true
                          }
                        }
                      }
                    ]
                  }
                }
              }
            },
            "labels": {
              "type": "array",
              "maxItems": 3,
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "name",
                  "color"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 32
                  },
                  "color": {
                    "type": "string",
                    "enum": [
                      "blue",
                      "cyan",
                      "green",
                      "orange",
                      "pink",
                      "purple",
                      "gray"
                    ]
                  }
                }
              }
            },
            "expectedRevision": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "sequenceId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:sequences"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "draft",
              "publishedVersionId",
              "status",
              "isDefault",
              "usedByCount",
              "createdAt",
              "revision"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "draft": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "schemaVersion",
                  "nodes"
                ],
                "properties": {
                  "schemaVersion": {
                    "type": "integer",
                    "enum": [
                      1
                    ]
                  },
                  "nodes": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "oneOf": [
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "trigger",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "trigger"
                              ]
                            },
                            "trigger": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "booking_created"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "confirmation_pending"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "after_booking_end"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "booking_rescheduled"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "offsetSeconds"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "before_booking"
                                      ]
                                    },
                                    "offsetSeconds": {
                                      "type": "number",
                                      "minimum": 0,
                                      "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                                    }
                                  }
                                }
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "durationSeconds",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "wait"
                              ]
                            },
                            "durationSeconds": {
                              "type": "number",
                              "minimum": 0,
                              "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "condition",
                            "yes",
                            "no"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "branch"
                              ]
                            },
                            "condition": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "kind",
                                "version"
                              ],
                              "properties": {
                                "kind": {
                                  "type": "string",
                                  "enum": [
                                    "booking_confirmed"
                                  ]
                                },
                                "version": {
                                  "type": "integer",
                                  "enum": [
                                    1
                                  ]
                                }
                              }
                            },
                            "yes": {
                              "type": "string",
                              "nullable": true
                            },
                            "no": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "content",
                            "recipient",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "content": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "texts"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "reminder"
                                      ]
                                    },
                                    "texts": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "locales"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "email"
                                      ]
                                    },
                                    "locales": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "invitee",
                                "host"
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "content",
                            "recipient",
                            "recipientEmail",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "content": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "texts"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "reminder"
                                      ]
                                    },
                                    "texts": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "locales"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "email"
                                      ]
                                    },
                                    "locales": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "specific_email"
                              ]
                            },
                            "recipientEmail": {
                              "type": "string"
                            },
                            "recipientEmails": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "templateVersionId",
                            "recipient",
                            "recipientEmail",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "templateVersionId": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "specific_email"
                              ]
                            },
                            "recipientEmail": {
                              "type": "string"
                            },
                            "recipientEmails": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "templateVersionId",
                            "recipient",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email",
                                "whatsapp"
                              ]
                            },
                            "templateVersionId": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "invitee",
                                "host"
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              },
              "labels": {
                "type": "array",
                "maxItems": 3,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "color"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32
                    },
                    "color": {
                      "type": "string",
                      "enum": [
                        "blue",
                        "cyan",
                        "green",
                        "orange",
                        "pink",
                        "purple",
                        "gray"
                      ]
                    }
                  }
                }
              },
              "emailContents": {
                "type": "object",
                "additionalProperties": {
                  "oneOf": [
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "kind",
                        "texts"
                      ],
                      "properties": {
                        "kind": {
                          "type": "string",
                          "enum": [
                            "reminder"
                          ]
                        },
                        "texts": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "subjectDate",
                                "title",
                                "greeting",
                                "reply",
                                "appointment",
                                "meeting",
                                "reschedule"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "subjectDate": {
                                  "type": "string"
                                },
                                "title": {
                                  "type": "string"
                                },
                                "greeting": {
                                  "type": "string"
                                },
                                "reply": {
                                  "type": "string"
                                },
                                "appointment": {
                                  "type": "string"
                                },
                                "meeting": {
                                  "type": "string"
                                },
                                "reschedule": {
                                  "type": "string"
                                }
                              }
                            },
                            "en": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "subjectDate",
                                "title",
                                "greeting",
                                "reply",
                                "appointment",
                                "meeting",
                                "reschedule"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "subjectDate": {
                                  "type": "string"
                                },
                                "title": {
                                  "type": "string"
                                },
                                "greeting": {
                                  "type": "string"
                                },
                                "reply": {
                                  "type": "string"
                                },
                                "appointment": {
                                  "type": "string"
                                },
                                "meeting": {
                                  "type": "string"
                                },
                                "reschedule": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "kind",
                        "locales"
                      ],
                      "properties": {
                        "kind": {
                          "type": "string",
                          "enum": [
                            "email"
                          ]
                        },
                        "locales": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "text",
                                "html"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "text": {
                                  "type": "string"
                                },
                                "html": {
                                  "type": "string"
                                }
                              }
                            },
                            "en": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "text",
                                "html"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "text": {
                                  "type": "string"
                                },
                                "html": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              },
              "publishedVersionId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160,
                "nullable": true
              },
              "status": {
                "type": "string",
                "enum": [
                  "draft",
                  "published"
                ]
              },
              "isDefault": {
                "type": "boolean"
              },
              "usedByCount": {
                "type": "integer"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              },
              "revision": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

DELETE /v1/sequences/{sequenceId}

deleteSequence

Required scopes: ["write:sequences"]

Request and responses
{
  "operationId": "deleteSequence",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "sequenceId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:sequences"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "id"
            ],
            "properties": {
              "id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/sequences/{sequenceId}/impact

getSequenceImpact

Required scopes: ["read:sequences"]

Request and responses
{
  "operationId": "getSequenceImpact",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "sequenceId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:sequences"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "count",
              "revision"
            ],
            "properties": {
              "count": {
                "type": "integer"
              },
              "revision": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/sequences/{sequenceId}/duplicate

duplicateSequence

Required scopes: ["write:sequences"]

Request and responses
{
  "operationId": "duplicateSequence",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "sequenceId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:sequences"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "draft",
              "publishedVersionId",
              "status",
              "isDefault",
              "usedByCount",
              "createdAt",
              "revision"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "draft": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "schemaVersion",
                  "nodes"
                ],
                "properties": {
                  "schemaVersion": {
                    "type": "integer",
                    "enum": [
                      1
                    ]
                  },
                  "nodes": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "oneOf": [
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "trigger",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "trigger"
                              ]
                            },
                            "trigger": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "booking_created"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "confirmation_pending"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "after_booking_end"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "booking_rescheduled"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "offsetSeconds"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "before_booking"
                                      ]
                                    },
                                    "offsetSeconds": {
                                      "type": "number",
                                      "minimum": 0,
                                      "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                                    }
                                  }
                                }
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "durationSeconds",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "wait"
                              ]
                            },
                            "durationSeconds": {
                              "type": "number",
                              "minimum": 0,
                              "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "condition",
                            "yes",
                            "no"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "branch"
                              ]
                            },
                            "condition": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "kind",
                                "version"
                              ],
                              "properties": {
                                "kind": {
                                  "type": "string",
                                  "enum": [
                                    "booking_confirmed"
                                  ]
                                },
                                "version": {
                                  "type": "integer",
                                  "enum": [
                                    1
                                  ]
                                }
                              }
                            },
                            "yes": {
                              "type": "string",
                              "nullable": true
                            },
                            "no": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "content",
                            "recipient",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "content": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "texts"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "reminder"
                                      ]
                                    },
                                    "texts": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "locales"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "email"
                                      ]
                                    },
                                    "locales": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "invitee",
                                "host"
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "content",
                            "recipient",
                            "recipientEmail",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "content": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "texts"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "reminder"
                                      ]
                                    },
                                    "texts": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "locales"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "email"
                                      ]
                                    },
                                    "locales": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "specific_email"
                              ]
                            },
                            "recipientEmail": {
                              "type": "string"
                            },
                            "recipientEmails": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "templateVersionId",
                            "recipient",
                            "recipientEmail",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "templateVersionId": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "specific_email"
                              ]
                            },
                            "recipientEmail": {
                              "type": "string"
                            },
                            "recipientEmails": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "templateVersionId",
                            "recipient",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email",
                                "whatsapp"
                              ]
                            },
                            "templateVersionId": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "invitee",
                                "host"
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              },
              "labels": {
                "type": "array",
                "maxItems": 3,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "color"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32
                    },
                    "color": {
                      "type": "string",
                      "enum": [
                        "blue",
                        "cyan",
                        "green",
                        "orange",
                        "pink",
                        "purple",
                        "gray"
                      ]
                    }
                  }
                }
              },
              "emailContents": {
                "type": "object",
                "additionalProperties": {
                  "oneOf": [
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "kind",
                        "texts"
                      ],
                      "properties": {
                        "kind": {
                          "type": "string",
                          "enum": [
                            "reminder"
                          ]
                        },
                        "texts": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "subjectDate",
                                "title",
                                "greeting",
                                "reply",
                                "appointment",
                                "meeting",
                                "reschedule"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "subjectDate": {
                                  "type": "string"
                                },
                                "title": {
                                  "type": "string"
                                },
                                "greeting": {
                                  "type": "string"
                                },
                                "reply": {
                                  "type": "string"
                                },
                                "appointment": {
                                  "type": "string"
                                },
                                "meeting": {
                                  "type": "string"
                                },
                                "reschedule": {
                                  "type": "string"
                                }
                              }
                            },
                            "en": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "subjectDate",
                                "title",
                                "greeting",
                                "reply",
                                "appointment",
                                "meeting",
                                "reschedule"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "subjectDate": {
                                  "type": "string"
                                },
                                "title": {
                                  "type": "string"
                                },
                                "greeting": {
                                  "type": "string"
                                },
                                "reply": {
                                  "type": "string"
                                },
                                "appointment": {
                                  "type": "string"
                                },
                                "meeting": {
                                  "type": "string"
                                },
                                "reschedule": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "kind",
                        "locales"
                      ],
                      "properties": {
                        "kind": {
                          "type": "string",
                          "enum": [
                            "email"
                          ]
                        },
                        "locales": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "text",
                                "html"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "text": {
                                  "type": "string"
                                },
                                "html": {
                                  "type": "string"
                                }
                              }
                            },
                            "en": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "text",
                                "html"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "text": {
                                  "type": "string"
                                },
                                "html": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              },
              "publishedVersionId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160,
                "nullable": true
              },
              "status": {
                "type": "string",
                "enum": [
                  "draft",
                  "published"
                ]
              },
              "isDefault": {
                "type": "boolean"
              },
              "usedByCount": {
                "type": "integer"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              },
              "revision": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/sequences/{sequenceId}/publish

publishSequence

Required scopes: ["write:sequences"]

Request and responses
{
  "operationId": "publishSequence",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "applyToFuture",
            "expectedRevision"
          ],
          "properties": {
            "applyToFuture": {
              "type": "boolean"
            },
            "expectedRevision": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "sequenceId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:sequences"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "draft",
              "publishedVersionId",
              "status",
              "isDefault",
              "usedByCount",
              "createdAt",
              "revision",
              "affectedBookings"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "draft": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "schemaVersion",
                  "nodes"
                ],
                "properties": {
                  "schemaVersion": {
                    "type": "integer",
                    "enum": [
                      1
                    ]
                  },
                  "nodes": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "oneOf": [
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "trigger",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "trigger"
                              ]
                            },
                            "trigger": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "booking_created"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "confirmation_pending"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "after_booking_end"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "booking_rescheduled"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "offsetSeconds"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "before_booking"
                                      ]
                                    },
                                    "offsetSeconds": {
                                      "type": "number",
                                      "minimum": 0,
                                      "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                                    }
                                  }
                                }
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "durationSeconds",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "wait"
                              ]
                            },
                            "durationSeconds": {
                              "type": "number",
                              "minimum": 0,
                              "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "condition",
                            "yes",
                            "no"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "branch"
                              ]
                            },
                            "condition": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "kind",
                                "version"
                              ],
                              "properties": {
                                "kind": {
                                  "type": "string",
                                  "enum": [
                                    "booking_confirmed"
                                  ]
                                },
                                "version": {
                                  "type": "integer",
                                  "enum": [
                                    1
                                  ]
                                }
                              }
                            },
                            "yes": {
                              "type": "string",
                              "nullable": true
                            },
                            "no": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "content",
                            "recipient",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "content": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "texts"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "reminder"
                                      ]
                                    },
                                    "texts": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "locales"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "email"
                                      ]
                                    },
                                    "locales": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "invitee",
                                "host"
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "content",
                            "recipient",
                            "recipientEmail",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "content": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "texts"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "reminder"
                                      ]
                                    },
                                    "texts": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "locales"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "email"
                                      ]
                                    },
                                    "locales": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "specific_email"
                              ]
                            },
                            "recipientEmail": {
                              "type": "string"
                            },
                            "recipientEmails": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "templateVersionId",
                            "recipient",
                            "recipientEmail",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "templateVersionId": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "specific_email"
                              ]
                            },
                            "recipientEmail": {
                              "type": "string"
                            },
                            "recipientEmails": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "templateVersionId",
                            "recipient",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email",
                                "whatsapp"
                              ]
                            },
                            "templateVersionId": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "invitee",
                                "host"
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              },
              "labels": {
                "type": "array",
                "maxItems": 3,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "color"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32
                    },
                    "color": {
                      "type": "string",
                      "enum": [
                        "blue",
                        "cyan",
                        "green",
                        "orange",
                        "pink",
                        "purple",
                        "gray"
                      ]
                    }
                  }
                }
              },
              "emailContents": {
                "type": "object",
                "additionalProperties": {
                  "oneOf": [
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "kind",
                        "texts"
                      ],
                      "properties": {
                        "kind": {
                          "type": "string",
                          "enum": [
                            "reminder"
                          ]
                        },
                        "texts": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "subjectDate",
                                "title",
                                "greeting",
                                "reply",
                                "appointment",
                                "meeting",
                                "reschedule"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "subjectDate": {
                                  "type": "string"
                                },
                                "title": {
                                  "type": "string"
                                },
                                "greeting": {
                                  "type": "string"
                                },
                                "reply": {
                                  "type": "string"
                                },
                                "appointment": {
                                  "type": "string"
                                },
                                "meeting": {
                                  "type": "string"
                                },
                                "reschedule": {
                                  "type": "string"
                                }
                              }
                            },
                            "en": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "subjectDate",
                                "title",
                                "greeting",
                                "reply",
                                "appointment",
                                "meeting",
                                "reschedule"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "subjectDate": {
                                  "type": "string"
                                },
                                "title": {
                                  "type": "string"
                                },
                                "greeting": {
                                  "type": "string"
                                },
                                "reply": {
                                  "type": "string"
                                },
                                "appointment": {
                                  "type": "string"
                                },
                                "meeting": {
                                  "type": "string"
                                },
                                "reschedule": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "kind",
                        "locales"
                      ],
                      "properties": {
                        "kind": {
                          "type": "string",
                          "enum": [
                            "email"
                          ]
                        },
                        "locales": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "text",
                                "html"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "text": {
                                  "type": "string"
                                },
                                "html": {
                                  "type": "string"
                                }
                              }
                            },
                            "en": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "text",
                                "html"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "text": {
                                  "type": "string"
                                },
                                "html": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              },
              "publishedVersionId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160,
                "nullable": true
              },
              "status": {
                "type": "string",
                "enum": [
                  "draft",
                  "published"
                ]
              },
              "isDefault": {
                "type": "boolean"
              },
              "usedByCount": {
                "type": "integer"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              },
              "revision": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              },
              "affectedBookings": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/sequences/{sequenceId}/unpublish

unpublishSequence

Required scopes: ["write:sequences"]

Request and responses
{
  "operationId": "unpublishSequence",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "expectedRevision"
          ],
          "properties": {
            "expectedRevision": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "sequenceId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:sequences"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "draft",
              "publishedVersionId",
              "status",
              "isDefault",
              "usedByCount",
              "createdAt",
              "revision"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "draft": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "schemaVersion",
                  "nodes"
                ],
                "properties": {
                  "schemaVersion": {
                    "type": "integer",
                    "enum": [
                      1
                    ]
                  },
                  "nodes": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "oneOf": [
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "trigger",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "trigger"
                              ]
                            },
                            "trigger": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "booking_created"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "confirmation_pending"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "after_booking_end"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "booking_rescheduled"
                                      ]
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "offsetSeconds"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "before_booking"
                                      ]
                                    },
                                    "offsetSeconds": {
                                      "type": "number",
                                      "minimum": 0,
                                      "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                                    }
                                  }
                                }
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "durationSeconds",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "wait"
                              ]
                            },
                            "durationSeconds": {
                              "type": "number",
                              "minimum": 0,
                              "description": "Positive duration in elapsed seconds; zero is rejected by domain validation."
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "condition",
                            "yes",
                            "no"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "branch"
                              ]
                            },
                            "condition": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "kind",
                                "version"
                              ],
                              "properties": {
                                "kind": {
                                  "type": "string",
                                  "enum": [
                                    "booking_confirmed"
                                  ]
                                },
                                "version": {
                                  "type": "integer",
                                  "enum": [
                                    1
                                  ]
                                }
                              }
                            },
                            "yes": {
                              "type": "string",
                              "nullable": true
                            },
                            "no": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "content",
                            "recipient",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "content": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "texts"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "reminder"
                                      ]
                                    },
                                    "texts": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "locales"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "email"
                                      ]
                                    },
                                    "locales": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "invitee",
                                "host"
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "content",
                            "recipient",
                            "recipientEmail",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "content": {
                              "oneOf": [
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "texts"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "reminder"
                                      ]
                                    },
                                    "texts": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "subjectDate",
                                            "title",
                                            "greeting",
                                            "reply",
                                            "appointment",
                                            "meeting",
                                            "reschedule"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "subjectDate": {
                                              "type": "string"
                                            },
                                            "title": {
                                              "type": "string"
                                            },
                                            "greeting": {
                                              "type": "string"
                                            },
                                            "reply": {
                                              "type": "string"
                                            },
                                            "appointment": {
                                              "type": "string"
                                            },
                                            "meeting": {
                                              "type": "string"
                                            },
                                            "reschedule": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                },
                                {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "kind",
                                    "locales"
                                  ],
                                  "properties": {
                                    "kind": {
                                      "type": "string",
                                      "enum": [
                                        "email"
                                      ]
                                    },
                                    "locales": {
                                      "type": "object",
                                      "additionalProperties": false,
                                      "required": [
                                        "de",
                                        "en"
                                      ],
                                      "properties": {
                                        "de": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        },
                                        "en": {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "subject",
                                            "text",
                                            "html"
                                          ],
                                          "properties": {
                                            "subject": {
                                              "type": "string"
                                            },
                                            "text": {
                                              "type": "string"
                                            },
                                            "html": {
                                              "type": "string"
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "specific_email"
                              ]
                            },
                            "recipientEmail": {
                              "type": "string"
                            },
                            "recipientEmails": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "templateVersionId",
                            "recipient",
                            "recipientEmail",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "templateVersionId": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "specific_email"
                              ]
                            },
                            "recipientEmail": {
                              "type": "string"
                            },
                            "recipientEmails": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "id",
                            "type",
                            "templateVersionId",
                            "recipient",
                            "next"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "email",
                                "whatsapp"
                              ]
                            },
                            "templateVersionId": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 160
                            },
                            "recipient": {
                              "type": "string",
                              "enum": [
                                "invitee",
                                "host"
                              ]
                            },
                            "next": {
                              "type": "string",
                              "nullable": true
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              },
              "labels": {
                "type": "array",
                "maxItems": 3,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "color"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32
                    },
                    "color": {
                      "type": "string",
                      "enum": [
                        "blue",
                        "cyan",
                        "green",
                        "orange",
                        "pink",
                        "purple",
                        "gray"
                      ]
                    }
                  }
                }
              },
              "emailContents": {
                "type": "object",
                "additionalProperties": {
                  "oneOf": [
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "kind",
                        "texts"
                      ],
                      "properties": {
                        "kind": {
                          "type": "string",
                          "enum": [
                            "reminder"
                          ]
                        },
                        "texts": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "subjectDate",
                                "title",
                                "greeting",
                                "reply",
                                "appointment",
                                "meeting",
                                "reschedule"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "subjectDate": {
                                  "type": "string"
                                },
                                "title": {
                                  "type": "string"
                                },
                                "greeting": {
                                  "type": "string"
                                },
                                "reply": {
                                  "type": "string"
                                },
                                "appointment": {
                                  "type": "string"
                                },
                                "meeting": {
                                  "type": "string"
                                },
                                "reschedule": {
                                  "type": "string"
                                }
                              }
                            },
                            "en": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "subjectDate",
                                "title",
                                "greeting",
                                "reply",
                                "appointment",
                                "meeting",
                                "reschedule"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "subjectDate": {
                                  "type": "string"
                                },
                                "title": {
                                  "type": "string"
                                },
                                "greeting": {
                                  "type": "string"
                                },
                                "reply": {
                                  "type": "string"
                                },
                                "appointment": {
                                  "type": "string"
                                },
                                "meeting": {
                                  "type": "string"
                                },
                                "reschedule": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "kind",
                        "locales"
                      ],
                      "properties": {
                        "kind": {
                          "type": "string",
                          "enum": [
                            "email"
                          ]
                        },
                        "locales": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "text",
                                "html"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "text": {
                                  "type": "string"
                                },
                                "html": {
                                  "type": "string"
                                }
                              }
                            },
                            "en": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "subject",
                                "text",
                                "html"
                              ],
                              "properties": {
                                "subject": {
                                  "type": "string"
                                },
                                "text": {
                                  "type": "string"
                                },
                                "html": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              },
              "publishedVersionId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160,
                "nullable": true
              },
              "status": {
                "type": "string",
                "enum": [
                  "draft",
                  "published"
                ]
              },
              "isDefault": {
                "type": "boolean"
              },
              "usedByCount": {
                "type": "integer"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              },
              "revision": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/message-templates

listMessageTemplates

Required scopes: ["read:message-templates"]

Request and responses
{
  "operationId": "listMessageTemplates",
  "parameters": [
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 25
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 0,
        "default": 0
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:message-templates"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "workspaceId",
                    "name",
                    "channel",
                    "draft",
                    "publishedVersionId",
                    "usedByCount",
                    "versionIds",
                    "createdAt",
                    "revision"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 160
                    },
                    "workspaceId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 160
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    "channel": {
                      "type": "string",
                      "enum": [
                        "email",
                        "whatsapp"
                      ]
                    },
                    "draft": {
                      "oneOf": [
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "kind",
                            "texts"
                          ],
                          "properties": {
                            "kind": {
                              "type": "string",
                              "enum": [
                                "reminder"
                              ]
                            },
                            "texts": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "de",
                                "en"
                              ],
                              "properties": {
                                "de": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "subject",
                                    "subjectDate",
                                    "title",
                                    "greeting",
                                    "reply",
                                    "appointment",
                                    "meeting",
                                    "reschedule"
                                  ],
                                  "properties": {
                                    "subject": {
                                      "type": "string"
                                    },
                                    "subjectDate": {
                                      "type": "string"
                                    },
                                    "title": {
                                      "type": "string"
                                    },
                                    "greeting": {
                                      "type": "string"
                                    },
                                    "reply": {
                                      "type": "string"
                                    },
                                    "appointment": {
                                      "type": "string"
                                    },
                                    "meeting": {
                                      "type": "string"
                                    },
                                    "reschedule": {
                                      "type": "string"
                                    }
                                  }
                                },
                                "en": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "subject",
                                    "subjectDate",
                                    "title",
                                    "greeting",
                                    "reply",
                                    "appointment",
                                    "meeting",
                                    "reschedule"
                                  ],
                                  "properties": {
                                    "subject": {
                                      "type": "string"
                                    },
                                    "subjectDate": {
                                      "type": "string"
                                    },
                                    "title": {
                                      "type": "string"
                                    },
                                    "greeting": {
                                      "type": "string"
                                    },
                                    "reply": {
                                      "type": "string"
                                    },
                                    "appointment": {
                                      "type": "string"
                                    },
                                    "meeting": {
                                      "type": "string"
                                    },
                                    "reschedule": {
                                      "type": "string"
                                    }
                                  }
                                }
                              }
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "kind",
                            "locales"
                          ],
                          "properties": {
                            "kind": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "locales": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "de",
                                "en"
                              ],
                              "properties": {
                                "de": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "subject",
                                    "text",
                                    "html"
                                  ],
                                  "properties": {
                                    "subject": {
                                      "type": "string"
                                    },
                                    "text": {
                                      "type": "string"
                                    },
                                    "html": {
                                      "type": "string"
                                    }
                                  }
                                },
                                "en": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "subject",
                                    "text",
                                    "html"
                                  ],
                                  "properties": {
                                    "subject": {
                                      "type": "string"
                                    },
                                    "text": {
                                      "type": "string"
                                    },
                                    "html": {
                                      "type": "string"
                                    }
                                  }
                                }
                              }
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "kind",
                            "locales"
                          ],
                          "properties": {
                            "kind": {
                              "type": "string",
                              "enum": [
                                "whatsapp"
                              ]
                            },
                            "locales": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "de",
                                "en"
                              ],
                              "properties": {
                                "de": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "name",
                                    "status",
                                    "variables"
                                  ],
                                  "properties": {
                                    "name": {
                                      "type": "string"
                                    },
                                    "status": {
                                      "type": "string",
                                      "enum": [
                                        "pending",
                                        "approved",
                                        "rejected"
                                      ]
                                    },
                                    "variables": {
                                      "type": "object",
                                      "additionalProperties": {
                                        "type": "string"
                                      }
                                    }
                                  }
                                },
                                "en": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "name",
                                    "status",
                                    "variables"
                                  ],
                                  "properties": {
                                    "name": {
                                      "type": "string"
                                    },
                                    "status": {
                                      "type": "string",
                                      "enum": [
                                        "pending",
                                        "approved",
                                        "rejected"
                                      ]
                                    },
                                    "variables": {
                                      "type": "object",
                                      "additionalProperties": {
                                        "type": "string"
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      ]
                    },
                    "publishedContent": {
                      "oneOf": [
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "kind",
                            "texts"
                          ],
                          "properties": {
                            "kind": {
                              "type": "string",
                              "enum": [
                                "reminder"
                              ]
                            },
                            "texts": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "de",
                                "en"
                              ],
                              "properties": {
                                "de": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "subject",
                                    "subjectDate",
                                    "title",
                                    "greeting",
                                    "reply",
                                    "appointment",
                                    "meeting",
                                    "reschedule"
                                  ],
                                  "properties": {
                                    "subject": {
                                      "type": "string"
                                    },
                                    "subjectDate": {
                                      "type": "string"
                                    },
                                    "title": {
                                      "type": "string"
                                    },
                                    "greeting": {
                                      "type": "string"
                                    },
                                    "reply": {
                                      "type": "string"
                                    },
                                    "appointment": {
                                      "type": "string"
                                    },
                                    "meeting": {
                                      "type": "string"
                                    },
                                    "reschedule": {
                                      "type": "string"
                                    }
                                  }
                                },
                                "en": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "subject",
                                    "subjectDate",
                                    "title",
                                    "greeting",
                                    "reply",
                                    "appointment",
                                    "meeting",
                                    "reschedule"
                                  ],
                                  "properties": {
                                    "subject": {
                                      "type": "string"
                                    },
                                    "subjectDate": {
                                      "type": "string"
                                    },
                                    "title": {
                                      "type": "string"
                                    },
                                    "greeting": {
                                      "type": "string"
                                    },
                                    "reply": {
                                      "type": "string"
                                    },
                                    "appointment": {
                                      "type": "string"
                                    },
                                    "meeting": {
                                      "type": "string"
                                    },
                                    "reschedule": {
                                      "type": "string"
                                    }
                                  }
                                }
                              }
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "kind",
                            "locales"
                          ],
                          "properties": {
                            "kind": {
                              "type": "string",
                              "enum": [
                                "email"
                              ]
                            },
                            "locales": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "de",
                                "en"
                              ],
                              "properties": {
                                "de": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "subject",
                                    "text",
                                    "html"
                                  ],
                                  "properties": {
                                    "subject": {
                                      "type": "string"
                                    },
                                    "text": {
                                      "type": "string"
                                    },
                                    "html": {
                                      "type": "string"
                                    }
                                  }
                                },
                                "en": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "subject",
                                    "text",
                                    "html"
                                  ],
                                  "properties": {
                                    "subject": {
                                      "type": "string"
                                    },
                                    "text": {
                                      "type": "string"
                                    },
                                    "html": {
                                      "type": "string"
                                    }
                                  }
                                }
                              }
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "kind",
                            "locales"
                          ],
                          "properties": {
                            "kind": {
                              "type": "string",
                              "enum": [
                                "whatsapp"
                              ]
                            },
                            "locales": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "de",
                                "en"
                              ],
                              "properties": {
                                "de": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "name",
                                    "status",
                                    "variables"
                                  ],
                                  "properties": {
                                    "name": {
                                      "type": "string"
                                    },
                                    "status": {
                                      "type": "string",
                                      "enum": [
                                        "pending",
                                        "approved",
                                        "rejected"
                                      ]
                                    },
                                    "variables": {
                                      "type": "object",
                                      "additionalProperties": {
                                        "type": "string"
                                      }
                                    }
                                  }
                                },
                                "en": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "name",
                                    "status",
                                    "variables"
                                  ],
                                  "properties": {
                                    "name": {
                                      "type": "string"
                                    },
                                    "status": {
                                      "type": "string",
                                      "enum": [
                                        "pending",
                                        "approved",
                                        "rejected"
                                      ]
                                    },
                                    "variables": {
                                      "type": "object",
                                      "additionalProperties": {
                                        "type": "string"
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      ]
                    },
                    "publishedVersionId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 160,
                      "nullable": true
                    },
                    "usedByCount": {
                      "type": "integer"
                    },
                    "versionIds": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 160
                      }
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "revision": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 128
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/message-templates

createMessageTemplate

Required scopes: ["write:message-templates"]

Request and responses
{
  "operationId": "createMessageTemplate",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name",
            "content"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "content": {
              "oneOf": [
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "kind",
                    "texts"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "reminder"
                      ]
                    },
                    "texts": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "subject",
                            "subjectDate",
                            "title",
                            "greeting",
                            "reply",
                            "appointment",
                            "meeting",
                            "reschedule"
                          ],
                          "properties": {
                            "subject": {
                              "type": "string"
                            },
                            "subjectDate": {
                              "type": "string"
                            },
                            "title": {
                              "type": "string"
                            },
                            "greeting": {
                              "type": "string"
                            },
                            "reply": {
                              "type": "string"
                            },
                            "appointment": {
                              "type": "string"
                            },
                            "meeting": {
                              "type": "string"
                            },
                            "reschedule": {
                              "type": "string"
                            }
                          }
                        },
                        "en": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "subject",
                            "subjectDate",
                            "title",
                            "greeting",
                            "reply",
                            "appointment",
                            "meeting",
                            "reschedule"
                          ],
                          "properties": {
                            "subject": {
                              "type": "string"
                            },
                            "subjectDate": {
                              "type": "string"
                            },
                            "title": {
                              "type": "string"
                            },
                            "greeting": {
                              "type": "string"
                            },
                            "reply": {
                              "type": "string"
                            },
                            "appointment": {
                              "type": "string"
                            },
                            "meeting": {
                              "type": "string"
                            },
                            "reschedule": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "kind",
                    "locales"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "email"
                      ]
                    },
                    "locales": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "subject",
                            "text",
                            "html"
                          ],
                          "properties": {
                            "subject": {
                              "type": "string"
                            },
                            "text": {
                              "type": "string"
                            },
                            "html": {
                              "type": "string"
                            }
                          }
                        },
                        "en": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "subject",
                            "text",
                            "html"
                          ],
                          "properties": {
                            "subject": {
                              "type": "string"
                            },
                            "text": {
                              "type": "string"
                            },
                            "html": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "kind",
                    "locales"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "whatsapp"
                      ]
                    },
                    "locales": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "name",
                            "status",
                            "variables"
                          ],
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "status": {
                              "type": "string",
                              "enum": [
                                "pending",
                                "approved",
                                "rejected"
                              ]
                            },
                            "variables": {
                              "type": "object",
                              "additionalProperties": {
                                "type": "string"
                              }
                            }
                          }
                        },
                        "en": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "name",
                            "status",
                            "variables"
                          ],
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "status": {
                              "type": "string",
                              "enum": [
                                "pending",
                                "approved",
                                "rejected"
                              ]
                            },
                            "variables": {
                              "type": "object",
                              "additionalProperties": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:message-templates"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "channel",
              "draft",
              "publishedVersionId",
              "usedByCount",
              "versionIds",
              "createdAt",
              "revision"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "channel": {
                "type": "string",
                "enum": [
                  "email",
                  "whatsapp"
                ]
              },
              "draft": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "texts"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "reminder"
                        ]
                      },
                      "texts": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "subjectDate",
                              "title",
                              "greeting",
                              "reply",
                              "appointment",
                              "meeting",
                              "reschedule"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "subjectDate": {
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              },
                              "greeting": {
                                "type": "string"
                              },
                              "reply": {
                                "type": "string"
                              },
                              "appointment": {
                                "type": "string"
                              },
                              "meeting": {
                                "type": "string"
                              },
                              "reschedule": {
                                "type": "string"
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "subjectDate",
                              "title",
                              "greeting",
                              "reply",
                              "appointment",
                              "meeting",
                              "reschedule"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "subjectDate": {
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              },
                              "greeting": {
                                "type": "string"
                              },
                              "reply": {
                                "type": "string"
                              },
                              "appointment": {
                                "type": "string"
                              },
                              "meeting": {
                                "type": "string"
                              },
                              "reschedule": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "locales"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "email"
                        ]
                      },
                      "locales": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "text",
                              "html"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "text": {
                                "type": "string"
                              },
                              "html": {
                                "type": "string"
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "text",
                              "html"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "text": {
                                "type": "string"
                              },
                              "html": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "locales"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "whatsapp"
                        ]
                      },
                      "locales": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "name",
                              "status",
                              "variables"
                            ],
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "status": {
                                "type": "string",
                                "enum": [
                                  "pending",
                                  "approved",
                                  "rejected"
                                ]
                              },
                              "variables": {
                                "type": "object",
                                "additionalProperties": {
                                  "type": "string"
                                }
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "name",
                              "status",
                              "variables"
                            ],
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "status": {
                                "type": "string",
                                "enum": [
                                  "pending",
                                  "approved",
                                  "rejected"
                                ]
                              },
                              "variables": {
                                "type": "object",
                                "additionalProperties": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                ]
              },
              "publishedContent": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "texts"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "reminder"
                        ]
                      },
                      "texts": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "subjectDate",
                              "title",
                              "greeting",
                              "reply",
                              "appointment",
                              "meeting",
                              "reschedule"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "subjectDate": {
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              },
                              "greeting": {
                                "type": "string"
                              },
                              "reply": {
                                "type": "string"
                              },
                              "appointment": {
                                "type": "string"
                              },
                              "meeting": {
                                "type": "string"
                              },
                              "reschedule": {
                                "type": "string"
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "subjectDate",
                              "title",
                              "greeting",
                              "reply",
                              "appointment",
                              "meeting",
                              "reschedule"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "subjectDate": {
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              },
                              "greeting": {
                                "type": "string"
                              },
                              "reply": {
                                "type": "string"
                              },
                              "appointment": {
                                "type": "string"
                              },
                              "meeting": {
                                "type": "string"
                              },
                              "reschedule": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "locales"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "email"
                        ]
                      },
                      "locales": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "text",
                              "html"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "text": {
                                "type": "string"
                              },
                              "html": {
                                "type": "string"
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "text",
                              "html"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "text": {
                                "type": "string"
                              },
                              "html": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "locales"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "whatsapp"
                        ]
                      },
                      "locales": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "name",
                              "status",
                              "variables"
                            ],
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "status": {
                                "type": "string",
                                "enum": [
                                  "pending",
                                  "approved",
                                  "rejected"
                                ]
                              },
                              "variables": {
                                "type": "object",
                                "additionalProperties": {
                                  "type": "string"
                                }
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "name",
                              "status",
                              "variables"
                            ],
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "status": {
                                "type": "string",
                                "enum": [
                                  "pending",
                                  "approved",
                                  "rejected"
                                ]
                              },
                              "variables": {
                                "type": "object",
                                "additionalProperties": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                ]
              },
              "publishedVersionId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160,
                "nullable": true
              },
              "usedByCount": {
                "type": "integer"
              },
              "versionIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 160
                }
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              },
              "revision": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/message-templates/{templateId}

getMessageTemplate

Required scopes: ["read:message-templates"]

Request and responses
{
  "operationId": "getMessageTemplate",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "templateId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:message-templates"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "channel",
              "draft",
              "publishedVersionId",
              "usedByCount",
              "versionIds",
              "createdAt",
              "revision"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "channel": {
                "type": "string",
                "enum": [
                  "email",
                  "whatsapp"
                ]
              },
              "draft": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "texts"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "reminder"
                        ]
                      },
                      "texts": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "subjectDate",
                              "title",
                              "greeting",
                              "reply",
                              "appointment",
                              "meeting",
                              "reschedule"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "subjectDate": {
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              },
                              "greeting": {
                                "type": "string"
                              },
                              "reply": {
                                "type": "string"
                              },
                              "appointment": {
                                "type": "string"
                              },
                              "meeting": {
                                "type": "string"
                              },
                              "reschedule": {
                                "type": "string"
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "subjectDate",
                              "title",
                              "greeting",
                              "reply",
                              "appointment",
                              "meeting",
                              "reschedule"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "subjectDate": {
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              },
                              "greeting": {
                                "type": "string"
                              },
                              "reply": {
                                "type": "string"
                              },
                              "appointment": {
                                "type": "string"
                              },
                              "meeting": {
                                "type": "string"
                              },
                              "reschedule": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "locales"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "email"
                        ]
                      },
                      "locales": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "text",
                              "html"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "text": {
                                "type": "string"
                              },
                              "html": {
                                "type": "string"
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "text",
                              "html"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "text": {
                                "type": "string"
                              },
                              "html": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "locales"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "whatsapp"
                        ]
                      },
                      "locales": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "name",
                              "status",
                              "variables"
                            ],
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "status": {
                                "type": "string",
                                "enum": [
                                  "pending",
                                  "approved",
                                  "rejected"
                                ]
                              },
                              "variables": {
                                "type": "object",
                                "additionalProperties": {
                                  "type": "string"
                                }
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "name",
                              "status",
                              "variables"
                            ],
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "status": {
                                "type": "string",
                                "enum": [
                                  "pending",
                                  "approved",
                                  "rejected"
                                ]
                              },
                              "variables": {
                                "type": "object",
                                "additionalProperties": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                ]
              },
              "publishedContent": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "texts"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "reminder"
                        ]
                      },
                      "texts": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "subjectDate",
                              "title",
                              "greeting",
                              "reply",
                              "appointment",
                              "meeting",
                              "reschedule"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "subjectDate": {
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              },
                              "greeting": {
                                "type": "string"
                              },
                              "reply": {
                                "type": "string"
                              },
                              "appointment": {
                                "type": "string"
                              },
                              "meeting": {
                                "type": "string"
                              },
                              "reschedule": {
                                "type": "string"
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "subjectDate",
                              "title",
                              "greeting",
                              "reply",
                              "appointment",
                              "meeting",
                              "reschedule"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "subjectDate": {
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              },
                              "greeting": {
                                "type": "string"
                              },
                              "reply": {
                                "type": "string"
                              },
                              "appointment": {
                                "type": "string"
                              },
                              "meeting": {
                                "type": "string"
                              },
                              "reschedule": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "locales"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "email"
                        ]
                      },
                      "locales": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "text",
                              "html"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "text": {
                                "type": "string"
                              },
                              "html": {
                                "type": "string"
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "text",
                              "html"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "text": {
                                "type": "string"
                              },
                              "html": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "locales"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "whatsapp"
                        ]
                      },
                      "locales": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "name",
                              "status",
                              "variables"
                            ],
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "status": {
                                "type": "string",
                                "enum": [
                                  "pending",
                                  "approved",
                                  "rejected"
                                ]
                              },
                              "variables": {
                                "type": "object",
                                "additionalProperties": {
                                  "type": "string"
                                }
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "name",
                              "status",
                              "variables"
                            ],
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "status": {
                                "type": "string",
                                "enum": [
                                  "pending",
                                  "approved",
                                  "rejected"
                                ]
                              },
                              "variables": {
                                "type": "object",
                                "additionalProperties": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                ]
              },
              "publishedVersionId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160,
                "nullable": true
              },
              "usedByCount": {
                "type": "integer"
              },
              "versionIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 160
                }
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              },
              "revision": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

PUT /v1/message-templates/{templateId}

updateMessageTemplate

Required scopes: ["write:message-templates"]

Request and responses
{
  "operationId": "updateMessageTemplate",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "content",
            "expectedRevision",
            "applyToPending"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "content": {
              "oneOf": [
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "kind",
                    "texts"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "reminder"
                      ]
                    },
                    "texts": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "subject",
                            "subjectDate",
                            "title",
                            "greeting",
                            "reply",
                            "appointment",
                            "meeting",
                            "reschedule"
                          ],
                          "properties": {
                            "subject": {
                              "type": "string"
                            },
                            "subjectDate": {
                              "type": "string"
                            },
                            "title": {
                              "type": "string"
                            },
                            "greeting": {
                              "type": "string"
                            },
                            "reply": {
                              "type": "string"
                            },
                            "appointment": {
                              "type": "string"
                            },
                            "meeting": {
                              "type": "string"
                            },
                            "reschedule": {
                              "type": "string"
                            }
                          }
                        },
                        "en": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "subject",
                            "subjectDate",
                            "title",
                            "greeting",
                            "reply",
                            "appointment",
                            "meeting",
                            "reschedule"
                          ],
                          "properties": {
                            "subject": {
                              "type": "string"
                            },
                            "subjectDate": {
                              "type": "string"
                            },
                            "title": {
                              "type": "string"
                            },
                            "greeting": {
                              "type": "string"
                            },
                            "reply": {
                              "type": "string"
                            },
                            "appointment": {
                              "type": "string"
                            },
                            "meeting": {
                              "type": "string"
                            },
                            "reschedule": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "kind",
                    "locales"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "email"
                      ]
                    },
                    "locales": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "subject",
                            "text",
                            "html"
                          ],
                          "properties": {
                            "subject": {
                              "type": "string"
                            },
                            "text": {
                              "type": "string"
                            },
                            "html": {
                              "type": "string"
                            }
                          }
                        },
                        "en": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "subject",
                            "text",
                            "html"
                          ],
                          "properties": {
                            "subject": {
                              "type": "string"
                            },
                            "text": {
                              "type": "string"
                            },
                            "html": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "kind",
                    "locales"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "whatsapp"
                      ]
                    },
                    "locales": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "name",
                            "status",
                            "variables"
                          ],
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "status": {
                              "type": "string",
                              "enum": [
                                "pending",
                                "approved",
                                "rejected"
                              ]
                            },
                            "variables": {
                              "type": "object",
                              "additionalProperties": {
                                "type": "string"
                              }
                            }
                          }
                        },
                        "en": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "name",
                            "status",
                            "variables"
                          ],
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "status": {
                              "type": "string",
                              "enum": [
                                "pending",
                                "approved",
                                "rejected"
                              ]
                            },
                            "variables": {
                              "type": "object",
                              "additionalProperties": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              ]
            },
            "expectedRevision": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            },
            "applyToPending": {
              "type": "boolean"
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "templateId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:message-templates"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "channel",
              "draft",
              "publishedVersionId",
              "usedByCount",
              "versionIds",
              "createdAt",
              "revision",
              "affectedMessages"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "channel": {
                "type": "string",
                "enum": [
                  "email",
                  "whatsapp"
                ]
              },
              "draft": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "texts"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "reminder"
                        ]
                      },
                      "texts": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "subjectDate",
                              "title",
                              "greeting",
                              "reply",
                              "appointment",
                              "meeting",
                              "reschedule"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "subjectDate": {
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              },
                              "greeting": {
                                "type": "string"
                              },
                              "reply": {
                                "type": "string"
                              },
                              "appointment": {
                                "type": "string"
                              },
                              "meeting": {
                                "type": "string"
                              },
                              "reschedule": {
                                "type": "string"
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "subjectDate",
                              "title",
                              "greeting",
                              "reply",
                              "appointment",
                              "meeting",
                              "reschedule"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "subjectDate": {
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              },
                              "greeting": {
                                "type": "string"
                              },
                              "reply": {
                                "type": "string"
                              },
                              "appointment": {
                                "type": "string"
                              },
                              "meeting": {
                                "type": "string"
                              },
                              "reschedule": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "locales"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "email"
                        ]
                      },
                      "locales": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "text",
                              "html"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "text": {
                                "type": "string"
                              },
                              "html": {
                                "type": "string"
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "text",
                              "html"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "text": {
                                "type": "string"
                              },
                              "html": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "locales"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "whatsapp"
                        ]
                      },
                      "locales": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "name",
                              "status",
                              "variables"
                            ],
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "status": {
                                "type": "string",
                                "enum": [
                                  "pending",
                                  "approved",
                                  "rejected"
                                ]
                              },
                              "variables": {
                                "type": "object",
                                "additionalProperties": {
                                  "type": "string"
                                }
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "name",
                              "status",
                              "variables"
                            ],
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "status": {
                                "type": "string",
                                "enum": [
                                  "pending",
                                  "approved",
                                  "rejected"
                                ]
                              },
                              "variables": {
                                "type": "object",
                                "additionalProperties": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                ]
              },
              "publishedContent": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "texts"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "reminder"
                        ]
                      },
                      "texts": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "subjectDate",
                              "title",
                              "greeting",
                              "reply",
                              "appointment",
                              "meeting",
                              "reschedule"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "subjectDate": {
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              },
                              "greeting": {
                                "type": "string"
                              },
                              "reply": {
                                "type": "string"
                              },
                              "appointment": {
                                "type": "string"
                              },
                              "meeting": {
                                "type": "string"
                              },
                              "reschedule": {
                                "type": "string"
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "subjectDate",
                              "title",
                              "greeting",
                              "reply",
                              "appointment",
                              "meeting",
                              "reschedule"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "subjectDate": {
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              },
                              "greeting": {
                                "type": "string"
                              },
                              "reply": {
                                "type": "string"
                              },
                              "appointment": {
                                "type": "string"
                              },
                              "meeting": {
                                "type": "string"
                              },
                              "reschedule": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "locales"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "email"
                        ]
                      },
                      "locales": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "text",
                              "html"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "text": {
                                "type": "string"
                              },
                              "html": {
                                "type": "string"
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "subject",
                              "text",
                              "html"
                            ],
                            "properties": {
                              "subject": {
                                "type": "string"
                              },
                              "text": {
                                "type": "string"
                              },
                              "html": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "locales"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "whatsapp"
                        ]
                      },
                      "locales": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "name",
                              "status",
                              "variables"
                            ],
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "status": {
                                "type": "string",
                                "enum": [
                                  "pending",
                                  "approved",
                                  "rejected"
                                ]
                              },
                              "variables": {
                                "type": "object",
                                "additionalProperties": {
                                  "type": "string"
                                }
                              }
                            }
                          },
                          "en": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "name",
                              "status",
                              "variables"
                            ],
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "status": {
                                "type": "string",
                                "enum": [
                                  "pending",
                                  "approved",
                                  "rejected"
                                ]
                              },
                              "variables": {
                                "type": "object",
                                "additionalProperties": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                ]
              },
              "publishedVersionId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160,
                "nullable": true
              },
              "usedByCount": {
                "type": "integer"
              },
              "versionIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 160
                }
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              },
              "revision": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              },
              "affectedMessages": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

DELETE /v1/message-templates/{templateId}

deleteMessageTemplate

Required scopes: ["write:message-templates"]

Request and responses
{
  "operationId": "deleteMessageTemplate",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "templateId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:message-templates"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "id"
            ],
            "properties": {
              "id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/message-templates/{templateId}/impact

getMessageTemplateImpact

Required scopes: ["read:message-templates"]

Request and responses
{
  "operationId": "getMessageTemplateImpact",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "templateId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:message-templates"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "count",
              "revision"
            ],
            "properties": {
              "count": {
                "type": "integer"
              },
              "revision": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/funnels/{funnelId}/sequences

getFunnelSequences

Required scopes: ["read:funnels"]

Request and responses
{
  "operationId": "getFunnelSequences",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "funnelId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:funnels"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "funnelId",
              "usesDefault",
              "sequenceIds",
              "effectiveSequenceIds",
              "defaultSequenceId",
              "confirmationRequired"
            ],
            "properties": {
              "funnelId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "usesDefault": {
                "type": "boolean"
              },
              "sequenceIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 160
                }
              },
              "effectiveSequenceIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 160
                }
              },
              "defaultSequenceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "confirmationRequired": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

PUT /v1/funnels/{funnelId}/sequences

setFunnelSequences

Required scopes: ["write:funnels"]

Request and responses
{
  "operationId": "setFunnelSequences",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "sequenceIds"
          ],
          "properties": {
            "sequenceIds": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "nullable": true
            },
            "confirmationRequired": {
              "type": "boolean"
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "funnelId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:funnels"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "funnelId",
              "usesDefault",
              "sequenceIds",
              "effectiveSequenceIds",
              "defaultSequenceId",
              "confirmationRequired"
            ],
            "properties": {
              "funnelId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "usesDefault": {
                "type": "boolean"
              },
              "sequenceIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 160
                }
              },
              "effectiveSequenceIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 160
                }
              },
              "defaultSequenceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "confirmationRequired": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/message-templates/preview

previewMessageTemplate

Required scopes: ["write:message-templates"]

Request and responses
{
  "operationId": "previewMessageTemplate",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "content",
            "locale"
          ],
          "properties": {
            "content": {
              "oneOf": [
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "kind",
                    "texts"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "reminder"
                      ]
                    },
                    "texts": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "subject",
                            "subjectDate",
                            "title",
                            "greeting",
                            "reply",
                            "appointment",
                            "meeting",
                            "reschedule"
                          ],
                          "properties": {
                            "subject": {
                              "type": "string"
                            },
                            "subjectDate": {
                              "type": "string"
                            },
                            "title": {
                              "type": "string"
                            },
                            "greeting": {
                              "type": "string"
                            },
                            "reply": {
                              "type": "string"
                            },
                            "appointment": {
                              "type": "string"
                            },
                            "meeting": {
                              "type": "string"
                            },
                            "reschedule": {
                              "type": "string"
                            }
                          }
                        },
                        "en": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "subject",
                            "subjectDate",
                            "title",
                            "greeting",
                            "reply",
                            "appointment",
                            "meeting",
                            "reschedule"
                          ],
                          "properties": {
                            "subject": {
                              "type": "string"
                            },
                            "subjectDate": {
                              "type": "string"
                            },
                            "title": {
                              "type": "string"
                            },
                            "greeting": {
                              "type": "string"
                            },
                            "reply": {
                              "type": "string"
                            },
                            "appointment": {
                              "type": "string"
                            },
                            "meeting": {
                              "type": "string"
                            },
                            "reschedule": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "kind",
                    "locales"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "email"
                      ]
                    },
                    "locales": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "subject",
                            "text",
                            "html"
                          ],
                          "properties": {
                            "subject": {
                              "type": "string"
                            },
                            "text": {
                              "type": "string"
                            },
                            "html": {
                              "type": "string"
                            }
                          }
                        },
                        "en": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "subject",
                            "text",
                            "html"
                          ],
                          "properties": {
                            "subject": {
                              "type": "string"
                            },
                            "text": {
                              "type": "string"
                            },
                            "html": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "kind",
                    "locales"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "whatsapp"
                      ]
                    },
                    "locales": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "name",
                            "status",
                            "variables"
                          ],
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "status": {
                              "type": "string",
                              "enum": [
                                "pending",
                                "approved",
                                "rejected"
                              ]
                            },
                            "variables": {
                              "type": "object",
                              "additionalProperties": {
                                "type": "string"
                              }
                            }
                          }
                        },
                        "en": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "name",
                            "status",
                            "variables"
                          ],
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "status": {
                              "type": "string",
                              "enum": [
                                "pending",
                                "approved",
                                "rejected"
                              ]
                            },
                            "variables": {
                              "type": "object",
                              "additionalProperties": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              ]
            },
            "locale": {
              "type": "string",
              "enum": [
                "de",
                "en"
              ]
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:message-templates"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "subject",
              "text",
              "html"
            ],
            "properties": {
              "subject": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "html": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/message-templates/{templateId}/test

testMessageTemplate

Required scopes: ["write:message-templates"]

Request and responses
{
  "operationId": "testMessageTemplate",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "locale"
          ],
          "properties": {
            "locale": {
              "type": "string",
              "enum": [
                "de",
                "en"
              ]
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "in": "path",
      "name": "templateId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:message-templates"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "202": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "status",
              "recipient"
            ],
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "accepted",
                  "unknown",
                  "failed"
                ]
              },
              "recipient": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/workspace-members

listWorkspaceMembers

Required scopes: ["read:workspace-members"]

Request and responses
{
  "operationId": "listWorkspaceMembers",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "maxLength": 200
      },
      "in": "query",
      "name": "search",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 0,
        "maximum": 2147483647
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "read:workspace-members"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "userId",
                    "name",
                    "email",
                    "role",
                    "hostIds"
                  ],
                  "properties": {
                    "userId": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "email": {
                      "type": "string"
                    },
                    "role": {
                      "type": "string",
                      "enum": [
                        "owner",
                        "admin",
                        "member"
                      ]
                    },
                    "hostIds": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "deactivationReason": {
                      "type": "string",
                      "enum": [
                        "plan"
                      ],
                      "nullable": true
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/workspace-invitations

listWorkspaceInvitations

Required scopes: ["read:workspace-invitations"]

Request and responses
{
  "operationId": "listWorkspaceInvitations",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "maxLength": 200
      },
      "in": "query",
      "name": "search",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 0,
        "maximum": 2147483647
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "read:workspace-invitations"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "email",
                    "role",
                    "createdAt",
                    "expiresAt",
                    "status",
                    "delivery"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "email": {
                      "type": "string"
                    },
                    "teamId": {
                      "type": "string",
                      "nullable": true
                    },
                    "role": {
                      "type": "string",
                      "enum": [
                        "admin",
                        "member"
                      ]
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "expiresAt": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "pending",
                        "accepted",
                        "revoked",
                        "expired"
                      ]
                    },
                    "delivery": {
                      "type": "string",
                      "enum": [
                        "pending",
                        "sent",
                        "failed"
                      ]
                    },
                    "currentMember": {
                      "type": "boolean"
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/workspace-invitations

createWorkspaceInvitation

Required scopes: ["write:workspace-invitations"]

Request and responses
{
  "operationId": "createWorkspaceInvitation",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "email",
            "role",
            "locale"
          ],
          "properties": {
            "teamId": {
              "type": "string",
              "nullable": true,
              "minLength": 1,
              "maxLength": 200
            },
            "email": {
              "type": "string",
              "minLength": 3,
              "maxLength": 320
            },
            "role": {
              "type": "string",
              "enum": [
                "admin",
                "member"
              ]
            },
            "locale": {
              "type": "string",
              "enum": [
                "de",
                "en"
              ]
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "write:workspace-invitations"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "email",
              "role",
              "createdAt",
              "expiresAt",
              "status",
              "delivery"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "teamId": {
                "type": "string",
                "nullable": true
              },
              "role": {
                "type": "string",
                "enum": [
                  "admin",
                  "member"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time"
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "accepted",
                  "revoked",
                  "expired"
                ]
              },
              "delivery": {
                "type": "string",
                "enum": [
                  "pending",
                  "sent",
                  "failed"
                ]
              },
              "currentMember": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/workspace-invitations/{invitationId}/resend

resendWorkspaceInvitation

Required scopes: ["write:workspace-invitations"]

Request and responses
{
  "operationId": "resendWorkspaceInvitation",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^wi_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "invitationId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "write:workspace-invitations"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "email",
              "role",
              "createdAt",
              "expiresAt",
              "status",
              "delivery"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "teamId": {
                "type": "string",
                "nullable": true
              },
              "role": {
                "type": "string",
                "enum": [
                  "admin",
                  "member"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time"
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "accepted",
                  "revoked",
                  "expired"
                ]
              },
              "delivery": {
                "type": "string",
                "enum": [
                  "pending",
                  "sent",
                  "failed"
                ]
              },
              "currentMember": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/workspace-invitations/{invitationId}/revoke

revokeWorkspaceInvitation

Required scopes: ["write:workspace-invitations"]

Request and responses
{
  "operationId": "revokeWorkspaceInvitation",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^wi_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "invitationId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "write:workspace-invitations"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "email",
              "role",
              "createdAt",
              "expiresAt",
              "status",
              "delivery"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "teamId": {
                "type": "string",
                "nullable": true
              },
              "role": {
                "type": "string",
                "enum": [
                  "admin",
                  "member"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time"
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "accepted",
                  "revoked",
                  "expired"
                ]
              },
              "delivery": {
                "type": "string",
                "enum": [
                  "pending",
                  "sent",
                  "failed"
                ]
              },
              "currentMember": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

PATCH /v1/workspace-members/{userId}

updateWorkspaceMember

Required scopes: ["write:workspace-members"]

Request and responses
{
  "operationId": "updateWorkspaceMember",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "role"
          ],
          "properties": {
            "role": {
              "type": "string",
              "enum": [
                "admin",
                "member"
              ]
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^us_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "userId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "write:workspace-members"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "userId"
            ],
            "properties": {
              "userId": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

DELETE /v1/workspace-members/{userId}

removeWorkspaceMember

Required scopes: ["write:workspace-members"]

Request and responses
{
  "operationId": "removeWorkspaceMember",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^us_[0-7][0-9A-HJKMNP-TV-Z]{25}$"
      },
      "in": "path",
      "name": "userId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "write:workspace-members"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "userId"
            ],
            "properties": {
              "userId": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/funnel-templates

listFunnelTemplates

Required scopes: ["read:funnels"]

Request and responses
{
  "operationId": "listFunnelTemplates",
  "parameters": [
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:funnels"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "id",
                "name",
                "settings",
                "mode",
                "captureAbandoned",
                "bookingWindowDays",
                "fields",
                "bookingCopy"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "enum": [
                    "coaching_intro"
                  ]
                },
                "name": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "maxDurationMinutes": {
                  "type": "integer",
                  "minimum": 1
                },
                "settings": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "mode": {
                      "type": "string",
                      "enum": [
                        "form_first",
                        "calendar_first",
                        "headless"
                      ]
                    },
                    "captureAbandoned": {
                      "type": "boolean",
                      "description": "Available only in form_first. calendar_first and headless always use false and reject explicit true."
                    },
                    "bookingWindowDays": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 36500
                    },
                    "fields": {
                      "type": "array",
                      "maxItems": 100,
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "required",
                          "label"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "pattern": "^[a-z][a-z0-9_]{0,79}$"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "text",
                              "email",
                              "phone",
                              "select",
                              "multiselect",
                              "scale",
                              "number",
                              "textarea",
                              "boolean",
                              "consent"
                            ]
                          },
                          "required": {
                            "type": "boolean"
                          },
                          "hidden": {
                            "type": "boolean"
                          },
                          "label": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "de",
                              "en"
                            ],
                            "properties": {
                              "de": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              },
                              "en": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              }
                            }
                          },
                          "min": {
                            "type": "number",
                            "description": "Required integer lower bound for a scale; optional numeric lower bound for a number field."
                          },
                          "max": {
                            "type": "number",
                            "description": "Required integer upper bound greater than min for a scale; optional numeric upper bound for a number field."
                          },
                          "options": {
                            "type": "array",
                            "minItems": 1,
                            "maxItems": 100,
                            "items": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "value",
                                "label"
                              ],
                              "properties": {
                                "value": {
                                  "type": "string",
                                  "minLength": 1,
                                  "maxLength": 80
                                },
                                "label": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "de",
                                    "en"
                                  ],
                                  "properties": {
                                    "de": {
                                      "type": "string",
                                      "minLength": 1,
                                      "maxLength": 2000
                                    },
                                    "en": {
                                      "type": "string",
                                      "minLength": 1,
                                      "maxLength": 2000
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "bookingCopy": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "headline",
                        "subheadline",
                        "submitLabel",
                        "confirmation",
                        "consent",
                        "privacyLinkLabel",
                        "privacyLinkSuffix",
                        "captureNotice"
                      ],
                      "properties": {
                        "headline": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "subheadline": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "submitLabel": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "confirmation": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "consent": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "privacyLinkLabel": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "privacyLinkSuffix": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "captureNotice": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        }
                      }
                    },
                    "descriptionFormat": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "enum": [
                            "plain",
                            "markdown"
                          ]
                        },
                        "en": {
                          "type": "string",
                          "enum": [
                            "plain",
                            "markdown"
                          ]
                        }
                      }
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    "labels": {
                      "type": "array",
                      "maxItems": 3,
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "name",
                          "color"
                        ],
                        "properties": {
                          "name": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 32
                          },
                          "color": {
                            "type": "string",
                            "enum": [
                              "blue",
                              "cyan",
                              "green",
                              "orange",
                              "pink",
                              "purple",
                              "gray"
                            ]
                          }
                        }
                      }
                    },
                    "slug": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 63,
                      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
                    },
                    "hostId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "teamId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "availabilityProfileId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80,
                      "nullable": true
                    },
                    "availability": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "days",
                          "startTime",
                          "endTime"
                        ],
                        "properties": {
                          "days": {
                            "type": "array",
                            "minItems": 1,
                            "items": {
                              "type": "integer",
                              "minimum": 0,
                              "maximum": 6
                            }
                          },
                          "startTime": {
                            "type": "string",
                            "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                          },
                          "endTime": {
                            "type": "string",
                            "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                          }
                        }
                      },
                      "nullable": true,
                      "deprecated": true,
                      "description": "Unsupported. Select an availability profile with availabilityProfileId instead (422)."
                    },
                    "durationMinutes": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 2147483647
                    },
                    "intervalMinutes": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 2147483647
                    },
                    "bufferBeforeMinutes": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 2147483647
                    },
                    "bufferAfterMinutes": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 2147483647
                    },
                    "minimumNoticeMinutes": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 2147483647
                    },
                    "maxBookingsPerDay": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 2147483647
                    },
                    "phoneRequired": {
                      "type": "boolean"
                    },
                    "confirmationRequired": {
                      "type": "boolean",
                      "description": "Require invitee confirmation before the configured expiry; an unconfirmed booking expires and releases its slot."
                    },
                    "locale": {
                      "type": "string",
                      "enum": [
                        "de",
                        "en"
                      ]
                    },
                    "rescheduleCutoffHours": {
                      "type": "number",
                      "minimum": 0,
                      "description": "Invitee rescheduling cutoff in hours. Zero permits rescheduling at any time."
                    },
                    "cancellationCutoffHours": {
                      "type": "number",
                      "minimum": 0,
                      "description": "Invitee cancellation cutoff in hours. Zero permits cancellation at any time. When omitted on creation, inherits the rescheduling cutoff; existing settings are preserved on updates."
                    },
                    "allowRescheduling": {
                      "type": "boolean",
                      "description": "Allow invitees to reschedule, subject to the change cutoff. Defaults to true; hosts are exempt."
                    },
                    "allowCancellation": {
                      "type": "boolean",
                      "description": "Allow invitees to cancel, subject to the change cutoff. Defaults to true; hosts are exempt."
                    },
                    "bookingChangeHint": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "video": {
                      "oneOf": [
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "kind"
                          ],
                          "properties": {
                            "kind": {
                              "type": "string",
                              "enum": [
                                "google_meet"
                              ]
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "kind",
                            "url"
                          ],
                          "properties": {
                            "kind": {
                              "type": "string",
                              "enum": [
                                "custom"
                              ]
                            },
                            "url": {
                              "type": "string",
                              "format": "uri",
                              "pattern": "^https://",
                              "maxLength": 2000
                            }
                          }
                        }
                      ]
                    }
                  }
                },
                "mode": {
                  "type": "string",
                  "enum": [
                    "form_first",
                    "calendar_first",
                    "headless"
                  ]
                },
                "captureAbandoned": {
                  "type": "boolean",
                  "description": "Available only in form_first. calendar_first and headless always use false and reject explicit true."
                },
                "bookingWindowDays": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 36500
                },
                "fields": {
                  "type": "array",
                  "maxItems": 100,
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "id",
                      "type",
                      "required",
                      "label"
                    ],
                    "properties": {
                      "id": {
                        "type": "string",
                        "pattern": "^[a-z][a-z0-9_]{0,79}$"
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "text",
                          "email",
                          "phone",
                          "select",
                          "multiselect",
                          "scale",
                          "number",
                          "textarea",
                          "boolean",
                          "consent"
                        ]
                      },
                      "required": {
                        "type": "boolean"
                      },
                      "hidden": {
                        "type": "boolean"
                      },
                      "label": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "de",
                          "en"
                        ],
                        "properties": {
                          "de": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 2000
                          },
                          "en": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 2000
                          }
                        }
                      },
                      "min": {
                        "type": "number",
                        "description": "Required integer lower bound for a scale; optional numeric lower bound for a number field."
                      },
                      "max": {
                        "type": "number",
                        "description": "Required integer upper bound greater than min for a scale; optional numeric upper bound for a number field."
                      },
                      "options": {
                        "type": "array",
                        "minItems": 1,
                        "maxItems": 100,
                        "items": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "value",
                            "label"
                          ],
                          "properties": {
                            "value": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 80
                            },
                            "label": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "de",
                                "en"
                              ],
                              "properties": {
                                "de": {
                                  "type": "string",
                                  "minLength": 1,
                                  "maxLength": 2000
                                },
                                "en": {
                                  "type": "string",
                                  "minLength": 1,
                                  "maxLength": 2000
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "bookingCopy": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "headline",
                    "subheadline",
                    "submitLabel",
                    "confirmation",
                    "consent",
                    "privacyLinkLabel",
                    "privacyLinkSuffix",
                    "captureNotice"
                  ],
                  "properties": {
                    "headline": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    },
                    "subheadline": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    },
                    "submitLabel": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    },
                    "confirmation": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    },
                    "consent": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    },
                    "privacyLinkLabel": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    },
                    "privacyLinkSuffix": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    },
                    "captureNotice": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    }
                  }
                },
                "descriptionFormat": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "enum": [
                        "plain",
                        "markdown"
                      ]
                    },
                    "en": {
                      "type": "string",
                      "enum": [
                        "plain",
                        "markdown"
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

GET /v1/funnels

listFunnels

Required scopes: ["read:funnels"]

Request and responses
{
  "operationId": "listFunnels",
  "parameters": [
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 25
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 0,
        "maximum": 2147483647,
        "default": 0
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:funnels"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "workspaceId",
                    "createdAt",
                    "name",
                    "slug",
                    "publicationStatus",
                    "publicUrl",
                    "durationMinutes",
                    "intervalMinutes",
                    "bufferBeforeMinutes",
                    "bufferAfterMinutes",
                    "minimumNoticeMinutes",
                    "maxBookingsPerDay",
                    "phoneRequired",
                    "confirmationRequired",
                    "locale",
                    "rescheduleCutoffHours",
                    "formVersion",
                    "availabilityProfileId",
                    "mode",
                    "captureAbandoned",
                    "bookingWindowDays",
                    "fields",
                    "bookingCopy"
                  ],
                  "properties": {
                    "mode": {
                      "type": "string",
                      "enum": [
                        "form_first",
                        "calendar_first",
                        "headless"
                      ]
                    },
                    "captureAbandoned": {
                      "type": "boolean",
                      "description": "Available only in form_first. calendar_first and headless always use false and reject explicit true."
                    },
                    "bookingWindowDays": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 36500
                    },
                    "fields": {
                      "type": "array",
                      "maxItems": 100,
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "id",
                          "type",
                          "required",
                          "label"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "pattern": "^[a-z][a-z0-9_]{0,79}$"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "text",
                              "email",
                              "phone",
                              "select",
                              "multiselect",
                              "scale",
                              "number",
                              "textarea",
                              "boolean",
                              "consent"
                            ]
                          },
                          "required": {
                            "type": "boolean"
                          },
                          "hidden": {
                            "type": "boolean"
                          },
                          "label": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "de",
                              "en"
                            ],
                            "properties": {
                              "de": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              },
                              "en": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              }
                            }
                          },
                          "min": {
                            "type": "number",
                            "description": "Required integer lower bound for a scale; optional numeric lower bound for a number field."
                          },
                          "max": {
                            "type": "number",
                            "description": "Required integer upper bound greater than min for a scale; optional numeric upper bound for a number field."
                          },
                          "options": {
                            "type": "array",
                            "minItems": 1,
                            "maxItems": 100,
                            "items": {
                              "type": "object",
                              "additionalProperties": false,
                              "required": [
                                "value",
                                "label"
                              ],
                              "properties": {
                                "value": {
                                  "type": "string",
                                  "minLength": 1,
                                  "maxLength": 80
                                },
                                "label": {
                                  "type": "object",
                                  "additionalProperties": false,
                                  "required": [
                                    "de",
                                    "en"
                                  ],
                                  "properties": {
                                    "de": {
                                      "type": "string",
                                      "minLength": 1,
                                      "maxLength": 2000
                                    },
                                    "en": {
                                      "type": "string",
                                      "minLength": 1,
                                      "maxLength": 2000
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "bookingCopy": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "headline",
                        "subheadline",
                        "submitLabel",
                        "confirmation",
                        "consent",
                        "privacyLinkLabel",
                        "privacyLinkSuffix",
                        "captureNotice"
                      ],
                      "properties": {
                        "headline": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "subheadline": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "submitLabel": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "confirmation": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "consent": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "privacyLinkLabel": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "privacyLinkSuffix": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        },
                        "captureNotice": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        }
                      }
                    },
                    "descriptionFormat": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "enum": [
                            "plain",
                            "markdown"
                          ]
                        },
                        "en": {
                          "type": "string",
                          "enum": [
                            "plain",
                            "markdown"
                          ]
                        }
                      }
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    "labels": {
                      "type": "array",
                      "maxItems": 3,
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "name",
                          "color"
                        ],
                        "properties": {
                          "name": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 32
                          },
                          "color": {
                            "type": "string",
                            "enum": [
                              "blue",
                              "cyan",
                              "green",
                              "orange",
                              "pink",
                              "purple",
                              "gray"
                            ]
                          }
                        }
                      }
                    },
                    "slug": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 63,
                      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
                      "nullable": true
                    },
                    "hostId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "teamId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "availabilityProfileId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80,
                      "nullable": true
                    },
                    "durationMinutes": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 2147483647
                    },
                    "intervalMinutes": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 2147483647
                    },
                    "bufferBeforeMinutes": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 2147483647
                    },
                    "bufferAfterMinutes": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 2147483647
                    },
                    "minimumNoticeMinutes": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 2147483647
                    },
                    "maxBookingsPerDay": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 2147483647
                    },
                    "phoneRequired": {
                      "type": "boolean"
                    },
                    "confirmationRequired": {
                      "type": "boolean",
                      "description": "Require invitee confirmation before the configured expiry; an unconfirmed booking expires and releases its slot."
                    },
                    "locale": {
                      "type": "string",
                      "enum": [
                        "de",
                        "en"
                      ]
                    },
                    "rescheduleCutoffHours": {
                      "type": "number",
                      "minimum": 0,
                      "description": "Invitee rescheduling cutoff in hours. Zero permits rescheduling at any time."
                    },
                    "cancellationCutoffHours": {
                      "type": "number",
                      "minimum": 0,
                      "description": "Invitee cancellation cutoff in hours. Zero permits cancellation at any time. When omitted on creation, inherits the rescheduling cutoff; existing settings are preserved on updates."
                    },
                    "allowRescheduling": {
                      "type": "boolean",
                      "description": "Allow invitees to reschedule, subject to the change cutoff. Defaults to true; hosts are exempt."
                    },
                    "allowCancellation": {
                      "type": "boolean",
                      "description": "Allow invitees to cancel, subject to the change cutoff. Defaults to true; hosts are exempt."
                    },
                    "bookingChangeHint": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "video": {
                      "oneOf": [
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "kind"
                          ],
                          "properties": {
                            "kind": {
                              "type": "string",
                              "enum": [
                                "google_meet"
                              ]
                            }
                          }
                        },
                        {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "kind",
                            "url"
                          ],
                          "properties": {
                            "kind": {
                              "type": "string",
                              "enum": [
                                "custom"
                              ]
                            },
                            "url": {
                              "type": "string",
                              "format": "uri",
                              "pattern": "^https://",
                              "maxLength": 2000
                            }
                          }
                        }
                      ]
                    },
                    "publicationStatus": {
                      "type": "string",
                      "enum": [
                        "draft",
                        "published"
                      ]
                    },
                    "publicUrl": {
                      "type": "string",
                      "nullable": true,
                      "format": "uri"
                    },
                    "templateId": {
                      "type": "string",
                      "enum": [
                        "coaching_intro"
                      ]
                    },
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "workspaceId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "formVersion": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 2147483647
                    }
                  }
                }
              },
              "total": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "limit": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "offset": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/funnels

createFunnel

Every assigned host must have a non-empty name; otherwise returns 422 host_name_required.

Required scopes: ["write:funnels"]

Request and responses
{
  "operationId": "createFunnel",
  "description": "Every assigned host must have a non-empty name; otherwise returns 422 host_name_required.",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name"
          ],
          "properties": {
            "mode": {
              "type": "string",
              "enum": [
                "form_first",
                "calendar_first",
                "headless"
              ],
              "description": "New funnels default to calendar-first. Existing funnels keep their stored mode."
            },
            "captureAbandoned": {
              "type": "boolean",
              "description": "Available only in form_first. calendar_first and headless always use false and reject explicit true."
            },
            "bookingWindowDays": {
              "type": "integer",
              "minimum": 1,
              "maximum": 36500
            },
            "fields": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "id",
                  "type",
                  "required",
                  "label"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^[a-z][a-z0-9_]{0,79}$"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "text",
                      "email",
                      "phone",
                      "select",
                      "multiselect",
                      "scale",
                      "number",
                      "textarea",
                      "boolean",
                      "consent"
                    ]
                  },
                  "required": {
                    "type": "boolean"
                  },
                  "hidden": {
                    "type": "boolean"
                  },
                  "label": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "min": {
                    "type": "number",
                    "description": "Required integer lower bound for a scale; optional numeric lower bound for a number field."
                  },
                  "max": {
                    "type": "number",
                    "description": "Required integer upper bound greater than min for a scale; optional numeric upper bound for a number field."
                  },
                  "options": {
                    "type": "array",
                    "minItems": 1,
                    "maxItems": 100,
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "value",
                        "label"
                      ],
                      "properties": {
                        "value": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 80
                        },
                        "label": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "de",
                            "en"
                          ],
                          "properties": {
                            "de": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            },
                            "en": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 2000
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            },
            "bookingCopy": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "headline",
                "subheadline",
                "submitLabel",
                "confirmation",
                "consent",
                "privacyLinkLabel",
                "privacyLinkSuffix",
                "captureNotice"
              ],
              "properties": {
                "headline": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "subheadline": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "submitLabel": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "confirmation": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "consent": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "privacyLinkLabel": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "privacyLinkSuffix": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                },
                "captureNotice": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "de",
                    "en"
                  ],
                  "properties": {
                    "de": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "en": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  }
                }
              }
            },
            "descriptionFormat": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "de",
                "en"
              ],
              "properties": {
                "de": {
                  "type": "string",
                  "enum": [
                    "plain",
                    "markdown"
                  ]
                },
                "en": {
                  "type": "string",
                  "enum": [
                    "plain",
                    "markdown"
                  ]
                }
              }
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "labels": {
              "type": "array",
              "maxItems": 3,
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "name",
                  "color"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 32
                  },
                  "color": {
                    "type": "string",
                    "enum": [
                      "blue",
                      "cyan",
                      "green",
                      "orange",
                      "pink",
                      "purple",
                      "gray"
                    ]
                  }
                }
              }
            },
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 63,
              "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
            },
            "hostId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "teamId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "availabilityProfileId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80,
              "nullable": true
            },
            "availability": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "days",
                  "startTime",
                  "endTime"
                ],
                "properties": {
                  "days": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 6
                    }
                  },
                  "startTime": {
                    "type": "string",
                    "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                  },
                  "endTime": {
                    "type": "string",
                    "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                  }
                }
              },
              "nullable": true,
              "deprecated": true,
              "description": "Unsupported. Select an availability profile with availabilityProfileId instead (422)."
            },
            "durationMinutes": {
              "type": "integer",
              "minimum": 1,
              "maximum": 2147483647
            },
            "intervalMinutes": {
              "type": "integer",
              "minimum": 1,
              "maximum": 2147483647
            },
            "bufferBeforeMinutes": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "bufferAfterMinutes": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "minimumNoticeMinutes": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "maxBookingsPerDay": {
              "type": "integer",
              "minimum": 1,
              "maximum": 2147483647
            },
            "phoneRequired": {
              "type": "boolean"
            },
            "confirmationRequired": {
              "type": "boolean",
              "description": "Require invitee confirmation before the configured expiry; an unconfirmed booking expires and releases its slot."
            },
            "locale": {
              "type": "string",
              "enum": [
                "de",
                "en"
              ]
            },
            "rescheduleCutoffHours": {
              "type": "number",
              "minimum": 0,
              "description": "Invitee rescheduling cutoff in hours. Zero permits rescheduling at any time."
            },
            "cancellationCutoffHours": {
              "type": "number",
              "minimum": 0,
              "description": "Invitee cancellation cutoff in hours. Zero permits cancellation at any time. When omitted on creation, inherits the rescheduling cutoff; existing settings are preserved on updates."
            },
            "allowRescheduling": {
              "type": "boolean",
              "description": "Allow invitees to reschedule, subject to the change cutoff. Defaults to true; hosts are exempt."
            },
            "allowCancellation": {
              "type": "boolean",
              "description": "Allow invitees to cancel, subject to the change cutoff. Defaults to true; hosts are exempt."
            },
            "bookingChangeHint": {
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            },
            "video": {
              "oneOf": [
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "kind"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "google_meet"
                      ]
                    }
                  }
                },
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "kind",
                    "url"
                  ],
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "custom"
                      ]
                    },
                    "url": {
                      "type": "string",
                      "format": "uri",
                      "pattern": "^https://",
                      "maxLength": 2000
                    }
                  }
                }
              ]
            },
            "templateId": {
              "type": "string",
              "enum": [
                "coaching_intro"
              ]
            }
          },
          "oneOf": [
            {
              "required": [
                "hostId"
              ],
              "not": {
                "required": [
                  "teamId"
                ]
              }
            },
            {
              "required": [
                "teamId"
              ],
              "not": {
                "required": [
                  "hostId"
                ]
              }
            }
          ]
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:funnels"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "createdAt",
              "name",
              "slug",
              "publicationStatus",
              "publicUrl",
              "durationMinutes",
              "intervalMinutes",
              "bufferBeforeMinutes",
              "bufferAfterMinutes",
              "minimumNoticeMinutes",
              "maxBookingsPerDay",
              "phoneRequired",
              "confirmationRequired",
              "locale",
              "rescheduleCutoffHours",
              "formVersion",
              "availabilityProfileId",
              "mode",
              "captureAbandoned",
              "bookingWindowDays",
              "fields",
              "bookingCopy"
            ],
            "properties": {
              "mode": {
                "type": "string",
                "enum": [
                  "form_first",
                  "calendar_first",
                  "headless"
                ]
              },
              "captureAbandoned": {
                "type": "boolean",
                "description": "Available only in form_first. calendar_first and headless always use false and reject explicit true."
              },
              "bookingWindowDays": {
                "type": "integer",
                "minimum": 1,
                "maximum": 36500
              },
              "fields": {
                "type": "array",
                "maxItems": 100,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "type",
                    "required",
                    "label"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{0,79}$"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "text",
                        "email",
                        "phone",
                        "select",
                        "multiselect",
                        "scale",
                        "number",
                        "textarea",
                        "boolean",
                        "consent"
                      ]
                    },
                    "required": {
                      "type": "boolean"
                    },
                    "hidden": {
                      "type": "boolean"
                    },
                    "label": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    },
                    "min": {
                      "type": "number",
                      "description": "Required integer lower bound for a scale; optional numeric lower bound for a number field."
                    },
                    "max": {
                      "type": "number",
                      "description": "Required integer upper bound greater than min for a scale; optional numeric upper bound for a number field."
                    },
                    "options": {
                      "type": "array",
                      "minItems": 1,
                      "maxItems": 100,
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "value",
                          "label"
                        ],
                        "properties": {
                          "value": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 80
                          },
                          "label": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "de",
                              "en"
                            ],
                            "properties": {
                              "de": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              },
                              "en": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              },
              "bookingCopy": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "headline",
                  "subheadline",
                  "submitLabel",
                  "confirmation",
                  "consent",
                  "privacyLinkLabel",
                  "privacyLinkSuffix",
                  "captureNotice"
                ],
                "properties": {
                  "headline": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "subheadline": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "submitLabel": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "confirmation": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "consent": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "privacyLinkLabel": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "privacyLinkSuffix": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "captureNotice": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  }
                }
              },
              "descriptionFormat": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "de",
                  "en"
                ],
                "properties": {
                  "de": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "markdown"
                    ]
                  },
                  "en": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "markdown"
                    ]
                  }
                }
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "labels": {
                "type": "array",
                "maxItems": 3,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "color"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32
                    },
                    "color": {
                      "type": "string",
                      "enum": [
                        "blue",
                        "cyan",
                        "green",
                        "orange",
                        "pink",
                        "purple",
                        "gray"
                      ]
                    }
                  }
                }
              },
              "slug": {
                "type": "string",
                "minLength": 1,
                "maxLength": 63,
                "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
                "nullable": true
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "teamId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "availabilityProfileId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "nullable": true
              },
              "durationMinutes": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "intervalMinutes": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "bufferBeforeMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "bufferAfterMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "minimumNoticeMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "maxBookingsPerDay": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "phoneRequired": {
                "type": "boolean"
              },
              "confirmationRequired": {
                "type": "boolean",
                "description": "Require invitee confirmation before the configured expiry; an unconfirmed booking expires and releases its slot."
              },
              "locale": {
                "type": "string",
                "enum": [
                  "de",
                  "en"
                ]
              },
              "rescheduleCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee rescheduling cutoff in hours. Zero permits rescheduling at any time."
              },
              "cancellationCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee cancellation cutoff in hours. Zero permits cancellation at any time. When omitted on creation, inherits the rescheduling cutoff; existing settings are preserved on updates."
              },
              "allowRescheduling": {
                "type": "boolean",
                "description": "Allow invitees to reschedule, subject to the change cutoff. Defaults to true; hosts are exempt."
              },
              "allowCancellation": {
                "type": "boolean",
                "description": "Allow invitees to cancel, subject to the change cutoff. Defaults to true; hosts are exempt."
              },
              "bookingChangeHint": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "video": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "google_meet"
                        ]
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "url"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "custom"
                        ]
                      },
                      "url": {
                        "type": "string",
                        "format": "uri",
                        "pattern": "^https://",
                        "maxLength": 2000
                      }
                    }
                  }
                ]
              },
              "publicationStatus": {
                "type": "string",
                "enum": [
                  "draft",
                  "published"
                ]
              },
              "publicUrl": {
                "type": "string",
                "nullable": true,
                "format": "uri"
              },
              "templateId": {
                "type": "string",
                "enum": [
                  "coaching_intro"
                ]
              },
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "formVersion": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/funnels/{funnelId}/settings

getFunnelSettings

Required scopes: ["read:funnels"]

Request and responses
{
  "operationId": "getFunnelSettings",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "funnelId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:funnels"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "createdAt",
              "name",
              "slug",
              "publicationStatus",
              "publicUrl",
              "durationMinutes",
              "intervalMinutes",
              "bufferBeforeMinutes",
              "bufferAfterMinutes",
              "minimumNoticeMinutes",
              "maxBookingsPerDay",
              "phoneRequired",
              "confirmationRequired",
              "locale",
              "rescheduleCutoffHours",
              "formVersion",
              "availabilityProfileId",
              "mode",
              "captureAbandoned",
              "bookingWindowDays",
              "fields",
              "bookingCopy"
            ],
            "properties": {
              "mode": {
                "type": "string",
                "enum": [
                  "form_first",
                  "calendar_first",
                  "headless"
                ]
              },
              "captureAbandoned": {
                "type": "boolean",
                "description": "Available only in form_first. calendar_first and headless always use false and reject explicit true."
              },
              "bookingWindowDays": {
                "type": "integer",
                "minimum": 1,
                "maximum": 36500
              },
              "fields": {
                "type": "array",
                "maxItems": 100,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "type",
                    "required",
                    "label"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{0,79}$"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "text",
                        "email",
                        "phone",
                        "select",
                        "multiselect",
                        "scale",
                        "number",
                        "textarea",
                        "boolean",
                        "consent"
                      ]
                    },
                    "required": {
                      "type": "boolean"
                    },
                    "hidden": {
                      "type": "boolean"
                    },
                    "label": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    },
                    "min": {
                      "type": "number",
                      "description": "Required integer lower bound for a scale; optional numeric lower bound for a number field."
                    },
                    "max": {
                      "type": "number",
                      "description": "Required integer upper bound greater than min for a scale; optional numeric upper bound for a number field."
                    },
                    "options": {
                      "type": "array",
                      "minItems": 1,
                      "maxItems": 100,
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "value",
                          "label"
                        ],
                        "properties": {
                          "value": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 80
                          },
                          "label": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "de",
                              "en"
                            ],
                            "properties": {
                              "de": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              },
                              "en": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              },
              "bookingCopy": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "headline",
                  "subheadline",
                  "submitLabel",
                  "confirmation",
                  "consent",
                  "privacyLinkLabel",
                  "privacyLinkSuffix",
                  "captureNotice"
                ],
                "properties": {
                  "headline": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "subheadline": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "submitLabel": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "confirmation": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "consent": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "privacyLinkLabel": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "privacyLinkSuffix": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "captureNotice": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  }
                }
              },
              "descriptionFormat": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "de",
                  "en"
                ],
                "properties": {
                  "de": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "markdown"
                    ]
                  },
                  "en": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "markdown"
                    ]
                  }
                }
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "labels": {
                "type": "array",
                "maxItems": 3,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "color"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32
                    },
                    "color": {
                      "type": "string",
                      "enum": [
                        "blue",
                        "cyan",
                        "green",
                        "orange",
                        "pink",
                        "purple",
                        "gray"
                      ]
                    }
                  }
                }
              },
              "slug": {
                "type": "string",
                "minLength": 1,
                "maxLength": 63,
                "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
                "nullable": true
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "teamId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "availabilityProfileId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "nullable": true
              },
              "durationMinutes": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "intervalMinutes": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "bufferBeforeMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "bufferAfterMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "minimumNoticeMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "maxBookingsPerDay": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "phoneRequired": {
                "type": "boolean"
              },
              "confirmationRequired": {
                "type": "boolean",
                "description": "Require invitee confirmation before the configured expiry; an unconfirmed booking expires and releases its slot."
              },
              "locale": {
                "type": "string",
                "enum": [
                  "de",
                  "en"
                ]
              },
              "rescheduleCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee rescheduling cutoff in hours. Zero permits rescheduling at any time."
              },
              "cancellationCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee cancellation cutoff in hours. Zero permits cancellation at any time. When omitted on creation, inherits the rescheduling cutoff; existing settings are preserved on updates."
              },
              "allowRescheduling": {
                "type": "boolean",
                "description": "Allow invitees to reschedule, subject to the change cutoff. Defaults to true; hosts are exempt."
              },
              "allowCancellation": {
                "type": "boolean",
                "description": "Allow invitees to cancel, subject to the change cutoff. Defaults to true; hosts are exempt."
              },
              "bookingChangeHint": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "video": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "google_meet"
                        ]
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "url"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "custom"
                        ]
                      },
                      "url": {
                        "type": "string",
                        "format": "uri",
                        "pattern": "^https://",
                        "maxLength": 2000
                      }
                    }
                  }
                ]
              },
              "publicationStatus": {
                "type": "string",
                "enum": [
                  "draft",
                  "published"
                ]
              },
              "publicUrl": {
                "type": "string",
                "nullable": true,
                "format": "uri"
              },
              "templateId": {
                "type": "string",
                "enum": [
                  "coaching_intro"
                ]
              },
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "formVersion": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/hosts

listHosts

Required scopes: ["read:hosts"]

Request and responses
{
  "operationId": "listHosts",
  "parameters": [
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 25
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 0,
        "maximum": 2147483647,
        "default": 0
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:hosts"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "workspaceId",
                    "name",
                    "email",
                    "timeZone",
                    "availability",
                    "calendarConnected"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    "email": {
                      "type": "string",
                      "format": "email",
                      "minLength": 1,
                      "maxLength": 320
                    },
                    "timeZone": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 100
                    },
                    "availability": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "days",
                          "startTime",
                          "endTime"
                        ],
                        "properties": {
                          "days": {
                            "type": "array",
                            "minItems": 1,
                            "items": {
                              "type": "integer",
                              "minimum": 0,
                              "maximum": 6
                            }
                          },
                          "startTime": {
                            "type": "string",
                            "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                          },
                          "endTime": {
                            "type": "string",
                            "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                          }
                        }
                      }
                    },
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "workspaceId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "calendarId": {
                      "type": "string"
                    },
                    "calendarIds": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "calendarConnected": {
                      "type": "boolean"
                    }
                  },
                  "description": "Calendar IDs are visible only to the bound host user and workspace owners/admins; connection state is visible to readers."
                }
              },
              "total": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "limit": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "offset": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/hosts

createHost

Required scopes: ["write:hosts"]

Request and responses
{
  "operationId": "createHost",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name",
            "email",
            "timeZone",
            "availability"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "email": {
              "type": "string",
              "format": "email",
              "minLength": 1,
              "maxLength": 320
            },
            "timeZone": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "availability": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "days",
                  "startTime",
                  "endTime"
                ],
                "properties": {
                  "days": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 6
                    }
                  },
                  "startTime": {
                    "type": "string",
                    "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                  },
                  "endTime": {
                    "type": "string",
                    "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:hosts"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "email",
              "timeZone",
              "availability",
              "calendarId",
              "calendarIds"
            ],
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "email": {
                "type": "string",
                "format": "email",
                "minLength": 1,
                "maxLength": 320
              },
              "timeZone": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "availability": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "days",
                    "startTime",
                    "endTime"
                  ],
                  "properties": {
                    "days": {
                      "type": "array",
                      "minItems": 1,
                      "items": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 6
                      }
                    },
                    "startTime": {
                      "type": "string",
                      "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                    },
                    "endTime": {
                      "type": "string",
                      "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                    }
                  }
                }
              },
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "calendarId": {
                "type": "string"
              },
              "calendarIds": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/hosts/{hostId}/availability-profiles

listAvailabilityProfiles

Required scopes: ["read:hosts"]

Request and responses
{
  "operationId": "listAvailabilityProfiles",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "hostId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:hosts"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "id",
                "workspaceId",
                "hostId",
                "name",
                "availability",
                "isDefault"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80
                },
                "workspaceId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80
                },
                "hostId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80
                },
                "name": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "availability": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "days",
                      "startTime",
                      "endTime"
                    ],
                    "properties": {
                      "days": {
                        "type": "array",
                        "minItems": 1,
                        "items": {
                          "type": "integer",
                          "minimum": 0,
                          "maximum": 6
                        }
                      },
                      "startTime": {
                        "type": "string",
                        "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                      },
                      "endTime": {
                        "type": "string",
                        "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                      }
                    }
                  }
                },
                "isDefault": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/hosts/{hostId}/availability-profiles

createAvailabilityProfile

Required scopes: ["write:hosts"]

Request and responses
{
  "operationId": "createAvailabilityProfile",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name",
            "availability"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "availability": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "days",
                  "startTime",
                  "endTime"
                ],
                "properties": {
                  "days": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 6
                    }
                  },
                  "startTime": {
                    "type": "string",
                    "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                  },
                  "endTime": {
                    "type": "string",
                    "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "hostId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:hosts"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "hostId",
              "name",
              "availability",
              "isDefault"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "availability": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "days",
                    "startTime",
                    "endTime"
                  ],
                  "properties": {
                    "days": {
                      "type": "array",
                      "minItems": 1,
                      "items": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 6
                      }
                    },
                    "startTime": {
                      "type": "string",
                      "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                    },
                    "endTime": {
                      "type": "string",
                      "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                    }
                  }
                }
              },
              "isDefault": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

PATCH /v1/hosts/{hostId}/availability-profiles/{profileId}

updateAvailabilityProfile

Required scopes: ["write:hosts"]

Request and responses
{
  "operationId": "updateAvailabilityProfile",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "availability": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "days",
                  "startTime",
                  "endTime"
                ],
                "properties": {
                  "days": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 6
                    }
                  },
                  "startTime": {
                    "type": "string",
                    "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                  },
                  "endTime": {
                    "type": "string",
                    "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "hostId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "profileId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:hosts"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "hostId",
              "name",
              "availability",
              "isDefault"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "availability": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "days",
                    "startTime",
                    "endTime"
                  ],
                  "properties": {
                    "days": {
                      "type": "array",
                      "minItems": 1,
                      "items": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 6
                      }
                    },
                    "startTime": {
                      "type": "string",
                      "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                    },
                    "endTime": {
                      "type": "string",
                      "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                    }
                  }
                }
              },
              "isDefault": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

DELETE /v1/hosts/{hostId}/availability-profiles/{profileId}

deleteAvailabilityProfile

Required scopes: ["write:hosts"]

Request and responses
{
  "operationId": "deleteAvailabilityProfile",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "hostId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "profileId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:hosts"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "hostId",
              "name",
              "availability",
              "isDefault"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "availability": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "days",
                    "startTime",
                    "endTime"
                  ],
                  "properties": {
                    "days": {
                      "type": "array",
                      "minItems": 1,
                      "items": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 6
                      }
                    },
                    "startTime": {
                      "type": "string",
                      "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                    },
                    "endTime": {
                      "type": "string",
                      "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                    }
                  }
                }
              },
              "isDefault": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/teams

listTeams

Required scopes: ["read:teams"]

Request and responses
{
  "operationId": "listTeams",
  "parameters": [
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 25
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 0,
        "maximum": 2147483647,
        "default": 0
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:teams"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "workspaceId",
                    "name",
                    "members"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "workspaceId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    "members": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "hostId",
                          "weight",
                          "joinedAt"
                        ],
                        "properties": {
                          "hostId": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 80
                          },
                          "weight": {
                            "type": "integer",
                            "minimum": 1,
                            "maximum": 2147483647
                          },
                          "joinedAt": {
                            "type": "string",
                            "format": "date-time",
                            "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                          }
                        }
                      }
                    }
                  }
                }
              },
              "total": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "limit": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "offset": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/teams

createTeam

Required scopes: ["write:teams"]

Request and responses
{
  "operationId": "createTeam",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "members": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "hostId",
                  "weight"
                ],
                "properties": {
                  "hostId": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 80
                  },
                  "weight": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 2147483647
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:teams"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "members"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "members": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "hostId",
                    "weight",
                    "joinedAt"
                  ],
                  "properties": {
                    "hostId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "weight": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 2147483647
                    },
                    "joinedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/funnels/{funnelId}/duplicate

duplicateFunnel

Creates an unpublished copy of a funnel and its settings without a public slug.

Required scopes: ["write:funnels"]

Request and responses
{
  "operationId": "duplicateFunnel",
  "description": "Creates an unpublished copy of a funnel and its settings without a public slug.",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "name"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "funnelId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:funnels"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "createdAt",
              "name",
              "slug",
              "publicationStatus",
              "publicUrl",
              "durationMinutes",
              "intervalMinutes",
              "bufferBeforeMinutes",
              "bufferAfterMinutes",
              "minimumNoticeMinutes",
              "maxBookingsPerDay",
              "phoneRequired",
              "confirmationRequired",
              "locale",
              "rescheduleCutoffHours",
              "formVersion",
              "availabilityProfileId",
              "mode",
              "captureAbandoned",
              "bookingWindowDays",
              "fields",
              "bookingCopy"
            ],
            "properties": {
              "mode": {
                "type": "string",
                "enum": [
                  "form_first",
                  "calendar_first",
                  "headless"
                ]
              },
              "captureAbandoned": {
                "type": "boolean",
                "description": "Available only in form_first. calendar_first and headless always use false and reject explicit true."
              },
              "bookingWindowDays": {
                "type": "integer",
                "minimum": 1,
                "maximum": 36500
              },
              "fields": {
                "type": "array",
                "maxItems": 100,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "type",
                    "required",
                    "label"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{0,79}$"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "text",
                        "email",
                        "phone",
                        "select",
                        "multiselect",
                        "scale",
                        "number",
                        "textarea",
                        "boolean",
                        "consent"
                      ]
                    },
                    "required": {
                      "type": "boolean"
                    },
                    "hidden": {
                      "type": "boolean"
                    },
                    "label": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    },
                    "min": {
                      "type": "number",
                      "description": "Required integer lower bound for a scale; optional numeric lower bound for a number field."
                    },
                    "max": {
                      "type": "number",
                      "description": "Required integer upper bound greater than min for a scale; optional numeric upper bound for a number field."
                    },
                    "options": {
                      "type": "array",
                      "minItems": 1,
                      "maxItems": 100,
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "value",
                          "label"
                        ],
                        "properties": {
                          "value": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 80
                          },
                          "label": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "de",
                              "en"
                            ],
                            "properties": {
                              "de": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              },
                              "en": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              },
              "bookingCopy": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "headline",
                  "subheadline",
                  "submitLabel",
                  "confirmation",
                  "consent",
                  "privacyLinkLabel",
                  "privacyLinkSuffix",
                  "captureNotice"
                ],
                "properties": {
                  "headline": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "subheadline": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "submitLabel": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "confirmation": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "consent": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "privacyLinkLabel": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "privacyLinkSuffix": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "captureNotice": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  }
                }
              },
              "descriptionFormat": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "de",
                  "en"
                ],
                "properties": {
                  "de": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "markdown"
                    ]
                  },
                  "en": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "markdown"
                    ]
                  }
                }
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "labels": {
                "type": "array",
                "maxItems": 3,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "color"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32
                    },
                    "color": {
                      "type": "string",
                      "enum": [
                        "blue",
                        "cyan",
                        "green",
                        "orange",
                        "pink",
                        "purple",
                        "gray"
                      ]
                    }
                  }
                }
              },
              "slug": {
                "type": "string",
                "minLength": 1,
                "maxLength": 63,
                "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
                "nullable": true
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "teamId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "availabilityProfileId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "nullable": true
              },
              "durationMinutes": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "intervalMinutes": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "bufferBeforeMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "bufferAfterMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "minimumNoticeMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "maxBookingsPerDay": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "phoneRequired": {
                "type": "boolean"
              },
              "confirmationRequired": {
                "type": "boolean",
                "description": "Require invitee confirmation before the configured expiry; an unconfirmed booking expires and releases its slot."
              },
              "locale": {
                "type": "string",
                "enum": [
                  "de",
                  "en"
                ]
              },
              "rescheduleCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee rescheduling cutoff in hours. Zero permits rescheduling at any time."
              },
              "cancellationCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee cancellation cutoff in hours. Zero permits cancellation at any time. When omitted on creation, inherits the rescheduling cutoff; existing settings are preserved on updates."
              },
              "allowRescheduling": {
                "type": "boolean",
                "description": "Allow invitees to reschedule, subject to the change cutoff. Defaults to true; hosts are exempt."
              },
              "allowCancellation": {
                "type": "boolean",
                "description": "Allow invitees to cancel, subject to the change cutoff. Defaults to true; hosts are exempt."
              },
              "bookingChangeHint": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "video": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "google_meet"
                        ]
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "url"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "custom"
                        ]
                      },
                      "url": {
                        "type": "string",
                        "format": "uri",
                        "pattern": "^https://",
                        "maxLength": 2000
                      }
                    }
                  }
                ]
              },
              "publicationStatus": {
                "type": "string",
                "enum": [
                  "draft",
                  "published"
                ]
              },
              "publicUrl": {
                "type": "string",
                "nullable": true,
                "format": "uri"
              },
              "templateId": {
                "type": "string",
                "enum": [
                  "coaching_intro"
                ]
              },
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "formVersion": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/funnels/{funnelId}/publication

setFunnelPublication

Publishing requires workspace and funnel slugs, named hosts and selected connected calendars. Publishing also requires a workspace privacy policy URL (422 privacy_policy_url_required). Existing published links remain online without one.

Required scopes: ["write:funnels"]

Request and responses
{
  "operationId": "setFunnelPublication",
  "description": "Publishing requires workspace and funnel slugs, named hosts and selected connected calendars. Publishing also requires a workspace privacy policy URL (422 privacy_policy_url_required). Existing published links remain online without one.",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "published"
          ],
          "properties": {
            "published": {
              "type": "boolean"
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "funnelId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:funnels"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "createdAt",
              "name",
              "slug",
              "publicationStatus",
              "publicUrl",
              "durationMinutes",
              "intervalMinutes",
              "bufferBeforeMinutes",
              "bufferAfterMinutes",
              "minimumNoticeMinutes",
              "maxBookingsPerDay",
              "phoneRequired",
              "confirmationRequired",
              "locale",
              "rescheduleCutoffHours",
              "formVersion",
              "availabilityProfileId",
              "mode",
              "captureAbandoned",
              "bookingWindowDays",
              "fields",
              "bookingCopy"
            ],
            "properties": {
              "mode": {
                "type": "string",
                "enum": [
                  "form_first",
                  "calendar_first",
                  "headless"
                ]
              },
              "captureAbandoned": {
                "type": "boolean",
                "description": "Available only in form_first. calendar_first and headless always use false and reject explicit true."
              },
              "bookingWindowDays": {
                "type": "integer",
                "minimum": 1,
                "maximum": 36500
              },
              "fields": {
                "type": "array",
                "maxItems": 100,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "type",
                    "required",
                    "label"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{0,79}$"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "text",
                        "email",
                        "phone",
                        "select",
                        "multiselect",
                        "scale",
                        "number",
                        "textarea",
                        "boolean",
                        "consent"
                      ]
                    },
                    "required": {
                      "type": "boolean"
                    },
                    "hidden": {
                      "type": "boolean"
                    },
                    "label": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "de",
                        "en"
                      ],
                      "properties": {
                        "de": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        },
                        "en": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 2000
                        }
                      }
                    },
                    "min": {
                      "type": "number",
                      "description": "Required integer lower bound for a scale; optional numeric lower bound for a number field."
                    },
                    "max": {
                      "type": "number",
                      "description": "Required integer upper bound greater than min for a scale; optional numeric upper bound for a number field."
                    },
                    "options": {
                      "type": "array",
                      "minItems": 1,
                      "maxItems": 100,
                      "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "value",
                          "label"
                        ],
                        "properties": {
                          "value": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 80
                          },
                          "label": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "de",
                              "en"
                            ],
                            "properties": {
                              "de": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              },
                              "en": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 2000
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              },
              "bookingCopy": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "headline",
                  "subheadline",
                  "submitLabel",
                  "confirmation",
                  "consent",
                  "privacyLinkLabel",
                  "privacyLinkSuffix",
                  "captureNotice"
                ],
                "properties": {
                  "headline": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "subheadline": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "submitLabel": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "confirmation": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "consent": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "privacyLinkLabel": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "privacyLinkSuffix": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  },
                  "captureNotice": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "de",
                      "en"
                    ],
                    "properties": {
                      "de": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "en": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      }
                    }
                  }
                }
              },
              "descriptionFormat": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "de",
                  "en"
                ],
                "properties": {
                  "de": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "markdown"
                    ]
                  },
                  "en": {
                    "type": "string",
                    "enum": [
                      "plain",
                      "markdown"
                    ]
                  }
                }
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "labels": {
                "type": "array",
                "maxItems": 3,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "color"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32
                    },
                    "color": {
                      "type": "string",
                      "enum": [
                        "blue",
                        "cyan",
                        "green",
                        "orange",
                        "pink",
                        "purple",
                        "gray"
                      ]
                    }
                  }
                }
              },
              "slug": {
                "type": "string",
                "minLength": 1,
                "maxLength": 63,
                "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
                "nullable": true
              },
              "hostId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "teamId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "availabilityProfileId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "nullable": true
              },
              "durationMinutes": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "intervalMinutes": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "bufferBeforeMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "bufferAfterMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "minimumNoticeMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 2147483647
              },
              "maxBookingsPerDay": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              },
              "phoneRequired": {
                "type": "boolean"
              },
              "confirmationRequired": {
                "type": "boolean",
                "description": "Require invitee confirmation before the configured expiry; an unconfirmed booking expires and releases its slot."
              },
              "locale": {
                "type": "string",
                "enum": [
                  "de",
                  "en"
                ]
              },
              "rescheduleCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee rescheduling cutoff in hours. Zero permits rescheduling at any time."
              },
              "cancellationCutoffHours": {
                "type": "number",
                "minimum": 0,
                "description": "Invitee cancellation cutoff in hours. Zero permits cancellation at any time. When omitted on creation, inherits the rescheduling cutoff; existing settings are preserved on updates."
              },
              "allowRescheduling": {
                "type": "boolean",
                "description": "Allow invitees to reschedule, subject to the change cutoff. Defaults to true; hosts are exempt."
              },
              "allowCancellation": {
                "type": "boolean",
                "description": "Allow invitees to cancel, subject to the change cutoff. Defaults to true; hosts are exempt."
              },
              "bookingChangeHint": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "video": {
                "oneOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "google_meet"
                        ]
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "kind",
                      "url"
                    ],
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "custom"
                        ]
                      },
                      "url": {
                        "type": "string",
                        "format": "uri",
                        "pattern": "^https://",
                        "maxLength": 2000
                      }
                    }
                  }
                ]
              },
              "publicationStatus": {
                "type": "string",
                "enum": [
                  "draft",
                  "published"
                ]
              },
              "publicUrl": {
                "type": "string",
                "nullable": true,
                "format": "uri"
              },
              "templateId": {
                "type": "string",
                "enum": [
                  "coaching_intro"
                ]
              },
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "formVersion": {
                "type": "integer",
                "minimum": 1,
                "maximum": 2147483647
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

PATCH /v1/hosts/{hostId}

updateHost

Required scopes: ["write:hosts"]

Request and responses
{
  "operationId": "updateHost",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "email": {
              "type": "string",
              "format": "email",
              "minLength": 1,
              "maxLength": 320
            },
            "timeZone": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "availability": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "days",
                  "startTime",
                  "endTime"
                ],
                "properties": {
                  "days": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 6
                    }
                  },
                  "startTime": {
                    "type": "string",
                    "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                  },
                  "endTime": {
                    "type": "string",
                    "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "hostId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:hosts"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "email",
              "timeZone",
              "availability",
              "calendarId",
              "calendarIds"
            ],
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "email": {
                "type": "string",
                "format": "email",
                "minLength": 1,
                "maxLength": 320
              },
              "timeZone": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "availability": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "days",
                    "startTime",
                    "endTime"
                  ],
                  "properties": {
                    "days": {
                      "type": "array",
                      "minItems": 1,
                      "items": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 6
                      }
                    },
                    "startTime": {
                      "type": "string",
                      "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                    },
                    "endTime": {
                      "type": "string",
                      "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                    }
                  }
                }
              },
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "calendarId": {
                "type": "string"
              },
              "calendarIds": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

PATCH /v1/teams/{teamId}

updateTeam

Required scopes: ["write:teams"]

Request and responses
{
  "operationId": "updateTeam",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "members": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "hostId",
                  "weight"
                ],
                "properties": {
                  "hostId": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 80
                  },
                  "weight": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 2147483647
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "teamId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:teams"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "members"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "members": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "hostId",
                    "weight",
                    "joinedAt"
                  ],
                  "properties": {
                    "hostId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "weight": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 2147483647
                    },
                    "joinedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/hosts/{hostId}/calendars

listHostCalendars

Required scopes: ["read:hosts"]

Request and responses
{
  "operationId": "listHostCalendars",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "hostId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "read:hosts"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "id",
                "name",
                "primary",
                "writable"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "primary": {
                  "type": "boolean"
                },
                "writable": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

PATCH /v1/hosts/{hostId}/calendars

setHostCalendars

Required scopes: ["write:hosts"]

Request and responses
{
  "operationId": "setHostCalendars",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "targetCalendarId",
            "conflictCalendarIds"
          ],
          "properties": {
            "targetCalendarId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 1024
            },
            "conflictCalendarIds": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 1024
              },
              "description": "The target calendar is always included in conflict checks."
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "hostId",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      },
      "in": "header",
      "name": "x-booking-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:hosts"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "workspaceId",
              "name",
              "email",
              "timeZone",
              "availability",
              "calendarId",
              "calendarIds"
            ],
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "email": {
                "type": "string",
                "format": "email",
                "minLength": 1,
                "maxLength": 320
              },
              "timeZone": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "availability": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "days",
                    "startTime",
                    "endTime"
                  ],
                  "properties": {
                    "days": {
                      "type": "array",
                      "minItems": 1,
                      "items": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 6
                      }
                    },
                    "startTime": {
                      "type": "string",
                      "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                    },
                    "endTime": {
                      "type": "string",
                      "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                    }
                  }
                }
              },
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "workspaceId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "calendarId": {
                "type": "string"
              },
              "calendarIds": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

POST /v1/leads

createLead

Required scopes: ["write:leads"]

Request and responses
{
  "operationId": "createLead",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "consent",
            "funnelId"
          ],
          "properties": {
            "invitee": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "email": {
                  "type": "string"
                },
                "phone": {
                  "type": "string"
                }
              }
            },
            "responses": {
              "type": "object",
              "additionalProperties": true
            },
            "consent": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "followup"
              ],
              "properties": {
                "followup": {
                  "type": "boolean"
                },
                "text": {
                  "type": "string",
                  "nullable": true,
                  "maxLength": 4000
                },
                "timestamp": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                  "nullable": true
                }
              }
            },
            "attribution": {
              "type": "object",
              "additionalProperties": {
                "type": "string",
                "maxLength": 2000
              }
            },
            "leadToken": {
              "type": "string",
              "maxLength": 200
            },
            "formVersion": {
              "type": "integer",
              "minimum": 1
            },
            "funnelId": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "maxLength": 200
      },
      "in": "header",
      "name": "x-sandbox-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "session": []
    }
  ],
  "x-required-scopes": [
    "write:leads"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "201": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "leadId",
              "leadToken",
              "warnings"
            ],
            "properties": {
              "leadId": {
                "type": "string"
              },
              "leadToken": {
                "type": "string"
              },
              "warnings": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "field_id",
                    "code",
                    "message"
                  ],
                  "properties": {
                    "field_id": {
                      "type": "string"
                    },
                    "code": {
                      "type": "string"
                    },
                    "message": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Stable (v1)

GET /v1/leads

listLeads

Required scopes: ["read:leads"]

Request and responses
{
  "operationId": "listLeads",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^[1-9][0-9]*$"
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "pattern": "^[0-9]+$"
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "query",
      "name": "funnelId",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "captured",
          "abandoned",
          "disqualified",
          "booked"
        ]
      },
      "in": "query",
      "name": "status",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "format": "date-time",
        "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
      },
      "in": "query",
      "name": "updated_since",
      "required": false,
      "description": "Inclusive update instant. Covers lead/capture changes and creation of related bookings; later booking changes belong to GET /v1/bookings?updated_since."
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "read:leads"
  ],
  "x-public-api": true,
  "x-api-stability": "stable",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "workspaceId",
                    "funnelId",
                    "funnelName",
                    "name",
                    "email",
                    "phone",
                    "status",
                    "consent",
                    "answers",
                    "attribution",
                    "formVersion",
                    "createdAt",
                    "updatedAt"
                  ],
                  "properties": {
                    "bookingBlockedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                      "nullable": true
                    },
                    "id": {
                      "type": "string"
                    },
                    "workspaceId": {
                      "type": "string"
                    },
                    "funnelId": {
                      "type": "string"
                    },
                    "funnelName": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "email": {
                      "type": "string"
                    },
                    "phone": {
                      "type": "string",
                      "nullable": true
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "captured",
                        "abandoned",
                        "disqualified",
                        "booked"
                      ]
                    },
                    "consent": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "followup",
                        "text",
                        "timestamp"
                      ],
                      "properties": {
                        "followup": {
                          "type": "boolean"
                        },
                        "text": {
                          "type": "string",
                          "nullable": true,
                          "maxLength": 4000
                        },
                        "timestamp": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                          "nullable": true
                        }
                      }
                    },
                    "answers": {
                      "type": "object",
                      "additionalProperties": true
                    },
                    "attribution": {
                      "type": "object",
                      "additionalProperties": {
                        "type": "string",
                        "maxLength": 2000
                      }
                    },
                    "formVersion": {
                      "type": "integer"
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "updatedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/leads/attribution

getLeadAttribution

Required scopes: ["read:leads"]

Request and responses
{
  "operationId": "getLeadAttribution",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^[1-9][0-9]*$"
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "pattern": "^[0-9]+$"
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "read:leads"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "source",
                    "campaign",
                    "leads",
                    "booked"
                  ],
                  "properties": {
                    "source": {
                      "type": "string",
                      "nullable": true
                    },
                    "campaign": {
                      "type": "string",
                      "nullable": true
                    },
                    "leads": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "booked": {
                      "type": "integer",
                      "minimum": 0
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/leads/summary

getLeadSummary

Required scopes: ["read:leads"]

Request and responses
{
  "operationId": "getLeadSummary",
  "parameters": [
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "read:leads"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "counts",
              "total"
            ],
            "properties": {
              "total": {
                "type": "integer",
                "minimum": 0
              },
              "counts": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "captured",
                  "abandoned",
                  "disqualified",
                  "booked"
                ],
                "properties": {
                  "captured": {
                    "type": "integer",
                    "minimum": 0
                  },
                  "abandoned": {
                    "type": "integer",
                    "minimum": 0
                  },
                  "disqualified": {
                    "type": "integer",
                    "minimum": 0
                  },
                  "booked": {
                    "type": "integer",
                    "minimum": 0
                  }
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/leads/{leadId}

getLead

Required scopes: ["read:leads"]

Request and responses
{
  "operationId": "getLead",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "in": "path",
      "name": "leadId",
      "required": true
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "read:leads"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "id",
              "workspaceId",
              "funnelId",
              "funnelName",
              "name",
              "email",
              "phone",
              "status",
              "consent",
              "answers",
              "attribution",
              "formVersion",
              "createdAt",
              "updatedAt"
            ],
            "properties": {
              "bookingBlockedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                "nullable": true
              },
              "id": {
                "type": "string"
              },
              "workspaceId": {
                "type": "string"
              },
              "funnelId": {
                "type": "string"
              },
              "funnelName": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "phone": {
                "type": "string",
                "nullable": true
              },
              "status": {
                "type": "string",
                "enum": [
                  "captured",
                  "abandoned",
                  "disqualified",
                  "booked"
                ]
              },
              "consent": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "followup",
                  "text",
                  "timestamp"
                ],
                "properties": {
                  "followup": {
                    "type": "boolean"
                  },
                  "text": {
                    "type": "string",
                    "nullable": true,
                    "maxLength": 4000
                  },
                  "timestamp": {
                    "type": "string",
                    "format": "date-time",
                    "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                    "nullable": true
                  }
                }
              },
              "answers": {
                "type": "object",
                "additionalProperties": true
              },
              "attribution": {
                "type": "object",
                "additionalProperties": {
                  "type": "string",
                  "maxLength": 2000
                }
              },
              "formVersion": {
                "type": "integer"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/contacts

listContacts

Required scopes: ["read:leads"]

Request and responses
{
  "operationId": "listContacts",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^[1-9][0-9]*$"
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "pattern": "^[0-9]+$"
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "maxLength": 200
      },
      "in": "query",
      "name": "search",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "all",
          "new",
          "no_upcoming",
          "captured",
          "abandoned",
          "disqualified",
          "booked"
        ]
      },
      "in": "query",
      "name": "filter",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "read:leads"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "status",
                    "name",
                    "email",
                    "phone",
                    "company",
                    "createdAt",
                    "lastMeetingAt",
                    "nextMeetingAt"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "captured",
                        "abandoned",
                        "disqualified",
                        "booked"
                      ]
                    },
                    "name": {
                      "type": "string"
                    },
                    "email": {
                      "type": "string",
                      "nullable": true
                    },
                    "phone": {
                      "type": "string",
                      "nullable": true
                    },
                    "company": {
                      "type": "string",
                      "nullable": true
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "lastMeetingAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                      "nullable": true
                    },
                    "nextMeetingAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                      "nullable": true
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

POST /v1/contacts/bulk-delete

deleteContacts

Required scopes: ["write:leads"]

Request and responses
{
  "operationId": "deleteContacts",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ids"
          ],
          "properties": {
            "ids": {
              "type": "array",
              "minItems": 1,
              "maxItems": 100,
              "uniqueItems": true,
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              }
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "idempotency-key",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "maxLength": 200
      },
      "in": "header",
      "name": "x-sandbox-token",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "in": "header",
      "name": "x-csrf-token",
      "required": false,
      "description": "Required for cookie session mutations; not required for API keys."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "write:leads"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "deleted"
            ],
            "properties": {
              "deleted": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
Beta, no stability guarantee

GET /v1/sandbox-bookings

listSandboxBookings

Required scopes: ["read:bookings"]

Request and responses
{
  "operationId": "listSandboxBookings",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^[1-9][0-9]*$"
      },
      "in": "query",
      "name": "limit",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "pattern": "^[0-9]+$"
      },
      "in": "query",
      "name": "offset",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "query",
      "name": "funnelId",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "format": "date-time",
        "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
      },
      "in": "query",
      "name": "from",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "format": "date-time",
        "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
      },
      "in": "query",
      "name": "to",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "header",
      "name": "x-workspace-id",
      "required": false,
      "description": "Workspace ID. Required for session authentication when the user has multiple memberships; must name one of their workspaces. API keys remain bound to their own workspace."
    }
  ],
  "security": [
    {
      "session": []
    },
    {
      "apiKey": []
    }
  ],
  "x-required-scopes": [
    "read:bookings"
  ],
  "x-public-api": true,
  "x-api-stability": "beta",
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "data",
              "total",
              "limit",
              "offset"
            ],
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "workspaceId",
                    "funnelId",
                    "hostId",
                    "leadId",
                    "start",
                    "end",
                    "timeZone",
                    "inviteeTimeZone",
                    "status",
                    "createdAt",
                    "formVersion",
                    "isTest",
                    "invitee",
                    "funnelName"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "workspaceId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "funnelId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "hostId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "teamId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "leadId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "start": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "end": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "timeZone": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 100
                    },
                    "inviteeTimeZone": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 100
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "pending_confirmation",
                        "confirmed",
                        "rescheduled",
                        "cancelled",
                        "expired",
                        "completed",
                        "no_show"
                      ]
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "rescheduleUrl": {
                      "type": "string",
                      "format": "uri",
                      "description": "Only returned with write:bookings."
                    },
                    "cancelUrl": {
                      "type": "string",
                      "format": "uri",
                      "description": "Only returned with write:bookings."
                    },
                    "confirmationUrl": {
                      "type": "string",
                      "format": "uri",
                      "description": "Only returned with write:bookings."
                    },
                    "confirmationExpiresAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "bookingChangeHint": {
                      "type": "string",
                      "description": "Host-provided contact instruction when modification links are unavailable."
                    },
                    "meetingUrl": {
                      "type": "string",
                      "format": "uri"
                    },
                    "version": {
                      "type": "integer",
                      "minimum": 1
                    },
                    "updatedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                    },
                    "formVersion": {
                      "type": "integer",
                      "minimum": 1
                    },
                    "isTest": {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    },
                    "invitee": {
                      "type": "object",
                      "required": [
                        "name",
                        "email"
                      ],
                      "properties": {
                        "name": {
                          "type": "string"
                        },
                        "email": {
                          "type": "string"
                        }
                      }
                    },
                    "funnelName": {
                      "type": "string"
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "410": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "413": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "415": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "422": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Limit": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        },
        "RateLimit-Remaining": {
          "schema": {
            "type": "integer",
            "minimum": 0
          }
        },
        "RateLimit-Reset": {
          "schema": {
            "type": "integer",
            "minimum": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "description": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "rate_limited"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "503": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "error",
              "request_id"
            ],
            "properties": {
              "error": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  },
                  "field": {
                    "type": "string"
                  },
                  "fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "field_id",
                        "code",
                        "message"
                      ],
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "alternatives": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "start",
                        "end",
                        "timeZone",
                        "local"
                      ],
                      "properties": {
                        "start": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "end": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                        },
                        "timeZone": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "local": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "date",
                            "time",
                            "offset"
                          ],
                          "properties": {
                            "date": {
                              "type": "string",
                              "format": "date"
                            },
                            "time": {
                              "type": "string",
                              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                            },
                            "offset": {
                              "type": "string",
                              "pattern": "^[+-][0-9]{2}:[0-9]{2}$"
                            }
                          }
                        }
                      }
                    }
                  },
                  "hint": {
                    "type": "string"
                  }
                }
              },
              "request_id": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}

Webhooks

Choose among nine events per endpoint; omitting the filter selects all: lead.captured, lead.abandoned, lead.converted, booking.created, booking.rescheduled, booking.cancelled, booking.confirmed_by_invitee, booking.expired, booking.completed. lead.disqualified and booking.no_show are reserved. Only events from endpoint creation onward are delivered; sandbox bookings are excluded.

Each POST contains event_id, type, created_at and data. data includes actor, schema_version, workspace_id, form_version, lead data, booking data when applicable, answers, attribution and the consent flag frozen in the event. data.test=true marks synthetic examples. Delivery history shows status, attempts, due time and dead-letter entries. Action tokens, action links and the Meet link are not part of the event payload; retrieve current booking details through GET /v1/bookings/{id} with the appropriate scopes.

Webhook-Signature has exactly the form t=<Unix seconds>,v1=<hex>. HMAC-SHA256 signs the UTF-8 timestamp bytes, a dot and the unmodified body bytes. Use the entire displayed whsec_ secret as the UTF-8 key, without Base64 decoding. Webhook-Id contains event_id.

Before parsing JSON, validate the signature format, a window in both directions around your current clock (for example 300 seconds, configurable by the receiver) and the expected HMAC in constant time. Read the raw body bytes; reserializing JSON changes the signed bytes. Reject invalid or stale requests, acknowledge valid ones with 2xx and deduplicate using event_id.

Retries retain event_id and the exact body with a new signature timestamp. A recorded success stops automatic attempts. A crash after remote acceptance but before local commit can cause another attempt. Explicit replay retains event_id with a new replay ID; repeating an Idempotency-Key creates no second replay. Deliberately decide whether your receiver should execute an already processed event again. During secret rotation, in-flight attempts may still use the previous secret; accept both during transition.

Per endpoint, booking.created for the same lead is sent only after a recorded 2xx success for its selected lead.captured, including across retries, backoff and restarts. A dead-letter capture keeps the booking pending without consuming booking attempts until an explicit capture replay succeeds. Planned dependencies survive filter changes. An original booking-only filter or a capture before endpoint creation creates no dependency; replays inherit the original association. Successful deliveries from earlier versions retain their replay eligibility. A later failed capture replay does not revoke an existing success. Other events and different endpoints have no global ordering guarantee.

Calberry stores lead and booking data in the EU. Webhooks send personal data to tools you select; those copies are stored where those tools operate and may leave the EU.

WebhookEvent
{
  "type": "object",
  "additionalProperties": false,
  "description": "Immutable public event snapshot. Only events at or after endpoint creation are delivered; sandbox bookings never produce deliveries. Retry and explicit replay retain event_id and the exact body. Per endpoint, booking.created waits for a recorded successful delivery of its selected lead.captured for the same lead. Retry, backoff and dead letter do not release that dependency; a successful explicit capture replay does. Filters excluding capture and captures before endpoint creation have no dependency. Replays retain the original dependency; successful deliveries from earlier versions retain their replay eligibility. No global ordering is guaranteed. lead.disqualified and booking.no_show are reserved. Action tokens, action links and the Meet link are excluded. Retrieve current booking details through GET /v1/bookings/{id} with the appropriate scopes. Personal data sent to host-selected destinations may leave the EU.",
  "required": [
    "event_id",
    "type",
    "created_at",
    "data"
  ],
  "properties": {
    "event_id": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "lead.captured",
        "lead.abandoned",
        "lead.converted",
        "booking.created",
        "booking.rescheduled",
        "booking.cancelled",
        "booking.confirmed_by_invitee",
        "booking.expired",
        "booking.completed"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
    },
    "data": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "actor",
        "schema_version",
        "workspace_id",
        "form_version",
        "consent",
        "lead",
        "answers",
        "attribution"
      ],
      "properties": {
        "actor": {
          "type": "string",
          "enum": [
            "invitee",
            "host",
            "system"
          ]
        },
        "schema_version": {
          "type": "integer",
          "enum": [
            1
          ]
        },
        "workspace_id": {
          "type": "string"
        },
        "form_version": {
          "type": "integer",
          "minimum": 1
        },
        "consent": {
          "type": "boolean",
          "description": "Follow-up consent frozen in this event, never inferred from the lead's current state."
        },
        "lead": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "id",
            "workspaceId",
            "funnelId"
          ],
          "properties": {
            "id": {
              "type": "string"
            },
            "workspaceId": {
              "type": "string"
            },
            "funnelId": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "email": {
              "type": "string"
            },
            "phone": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "type": "string",
              "enum": [
                "captured",
                "abandoned",
                "disqualified",
                "booked"
              ]
            },
            "createdAt": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            },
            "updatedAt": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            }
          }
        },
        "booking": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "id": {
              "type": "string"
            },
            "workspaceId": {
              "type": "string"
            },
            "funnelId": {
              "type": "string"
            },
            "hostId": {
              "type": "string"
            },
            "teamId": {
              "type": "string"
            },
            "leadId": {
              "type": "string"
            },
            "start": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            },
            "end": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            },
            "timeZone": {
              "type": "string"
            },
            "inviteeTimeZone": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "pending_confirmation",
                "confirmed",
                "rescheduled",
                "cancelled",
                "expired",
                "completed",
                "no_show"
              ]
            },
            "createdAt": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            },
            "updatedAt": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            }
          }
        },
        "answers": {
          "type": "object",
          "additionalProperties": true
        },
        "attribution": {
          "type": "object",
          "additionalProperties": true
        },
        "test": {
          "type": "boolean",
          "enum": [
            true
          ],
          "description": "Synthetic test event with example data only."
        }
      }
    }
  }
}

Schemas

Schemas
{
  "securitySchemes": {
    "emailUnsubscribe": {
      "type": "apiKey",
      "in": "query",
      "name": "token",
      "description": "Opaque capability authorizing only email suppression for its bound workspace and address."
    },
    "session": {
      "type": "apiKey",
      "in": "cookie",
      "name": "__Host-app_session"
    },
    "refreshSession": {
      "type": "apiKey",
      "in": "cookie",
      "name": "__Host-app_refresh"
    },
    "apiKey": {
      "type": "http",
      "scheme": "bearer",
      "description": "Workspace API key. Required scopes are enforced and declared by x-required-scopes on each operation."
    },
    "bookingLink": {
      "type": "apiKey",
      "in": "header",
      "name": "X-Booking-Token",
      "description": "Signed token bound to this booking and action; expires at its declared UTC instant."
    },
    "bookingLinkQuery": {
      "type": "apiKey",
      "in": "query",
      "name": "token",
      "description": "Signed booking link token for read-only action preview."
    }
  },
  "schemas": {
    "EventActor": {
      "type": "string",
      "enum": [
        "invitee",
        "host",
        "system"
      ]
    },
    "BookingEvent": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "id",
        "name",
        "actor",
        "schema_version",
        "form_version",
        "occurred_at",
        "workspace_id",
        "booking",
        "lead",
        "consent",
        "answers",
        "attribution"
      ],
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 80
        },
        "name": {
          "type": "string",
          "enum": [
            "booking.created",
            "booking.confirmed_by_invitee",
            "booking.rescheduled",
            "booking.cancelled",
            "booking.completed",
            "booking.expired"
          ]
        },
        "actor": {
          "$ref": "#/components/schemas/EventActor"
        },
        "schema_version": {
          "type": "integer",
          "enum": [
            1
          ]
        },
        "form_version": {
          "type": "integer",
          "minimum": 1
        },
        "occurred_at": {
          "type": "string",
          "format": "date-time",
          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
        },
        "workspace_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 80
        },
        "booking": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "id",
            "workspaceId",
            "funnelId",
            "hostId",
            "leadId",
            "start",
            "end",
            "timeZone",
            "inviteeTimeZone",
            "status",
            "createdAt",
            "formVersion"
          ],
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "workspaceId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "funnelId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "hostId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "teamId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "leadId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "start": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            },
            "end": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            },
            "timeZone": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "inviteeTimeZone": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "status": {
              "type": "string",
              "enum": [
                "pending_confirmation",
                "confirmed",
                "rescheduled",
                "cancelled",
                "expired",
                "completed",
                "no_show"
              ]
            },
            "createdAt": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            },
            "rescheduleUrl": {
              "type": "string",
              "format": "uri",
              "description": "Only returned with write:bookings."
            },
            "cancelUrl": {
              "type": "string",
              "format": "uri",
              "description": "Only returned with write:bookings."
            },
            "confirmationUrl": {
              "type": "string",
              "format": "uri",
              "description": "Only returned with write:bookings."
            },
            "confirmationExpiresAt": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            },
            "bookingChangeHint": {
              "type": "string",
              "description": "Host-provided contact instruction when modification links are unavailable."
            },
            "meetingUrl": {
              "type": "string",
              "format": "uri"
            },
            "version": {
              "type": "integer",
              "minimum": 1
            },
            "updatedAt": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            },
            "formVersion": {
              "type": "integer",
              "minimum": 1
            }
          }
        },
        "lead": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "id",
            "workspaceId",
            "funnelId",
            "name",
            "email",
            "phone",
            "status",
            "consent",
            "answers",
            "attribution",
            "formVersion",
            "createdAt"
          ],
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "workspaceId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "funnelId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "email": {
              "type": "string",
              "format": "email",
              "maxLength": 320
            },
            "phone": {
              "type": "string",
              "minLength": 1,
              "maxLength": 40,
              "nullable": true
            },
            "status": {
              "type": "string",
              "enum": [
                "booked"
              ]
            },
            "consent": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "followup",
                "text",
                "timestamp"
              ],
              "properties": {
                "followup": {
                  "type": "boolean"
                },
                "text": {
                  "type": "string",
                  "nullable": true,
                  "maxLength": 4000
                },
                "timestamp": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
                  "nullable": true
                }
              }
            },
            "answers": {
              "type": "object",
              "additionalProperties": true
            },
            "attribution": {
              "type": "object",
              "additionalProperties": {
                "type": "string",
                "maxLength": 2000
              }
            },
            "formVersion": {
              "type": "integer",
              "minimum": 1
            },
            "createdAt": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
            }
          }
        },
        "consent": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "followup",
            "text",
            "timestamp"
          ],
          "properties": {
            "followup": {
              "type": "boolean"
            },
            "text": {
              "type": "string",
              "nullable": true,
              "maxLength": 4000
            },
            "timestamp": {
              "type": "string",
              "format": "date-time",
              "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$",
              "nullable": true
            }
          }
        },
        "answers": {
          "type": "object",
          "additionalProperties": true
        },
        "attribution": {
          "type": "object",
          "additionalProperties": {
            "type": "string",
            "maxLength": 2000
          }
        }
      }
    },
    "WebhookEvent": {
      "type": "object",
      "additionalProperties": false,
      "description": "Immutable public event snapshot. Only events at or after endpoint creation are delivered; sandbox bookings never produce deliveries. Retry and explicit replay retain event_id and the exact body. Per endpoint, booking.created waits for a recorded successful delivery of its selected lead.captured for the same lead. Retry, backoff and dead letter do not release that dependency; a successful explicit capture replay does. Filters excluding capture and captures before endpoint creation have no dependency. Replays retain the original dependency; successful deliveries from earlier versions retain their replay eligibility. No global ordering is guaranteed. lead.disqualified and booking.no_show are reserved. Action tokens, action links and the Meet link are excluded. Retrieve current booking details through GET /v1/bookings/{id} with the appropriate scopes. Personal data sent to host-selected destinations may leave the EU.",
      "required": [
        "event_id",
        "type",
        "created_at",
        "data"
      ],
      "properties": {
        "event_id": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "lead.captured",
            "lead.abandoned",
            "lead.converted",
            "booking.created",
            "booking.rescheduled",
            "booking.cancelled",
            "booking.confirmed_by_invitee",
            "booking.expired",
            "booking.completed"
          ]
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
        },
        "data": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "actor",
            "schema_version",
            "workspace_id",
            "form_version",
            "consent",
            "lead",
            "answers",
            "attribution"
          ],
          "properties": {
            "actor": {
              "type": "string",
              "enum": [
                "invitee",
                "host",
                "system"
              ]
            },
            "schema_version": {
              "type": "integer",
              "enum": [
                1
              ]
            },
            "workspace_id": {
              "type": "string"
            },
            "form_version": {
              "type": "integer",
              "minimum": 1
            },
            "consent": {
              "type": "boolean",
              "description": "Follow-up consent frozen in this event, never inferred from the lead's current state."
            },
            "lead": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "id",
                "workspaceId",
                "funnelId"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "workspaceId": {
                  "type": "string"
                },
                "funnelId": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "email": {
                  "type": "string"
                },
                "phone": {
                  "type": "string",
                  "nullable": true
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "captured",
                    "abandoned",
                    "disqualified",
                    "booked"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                }
              }
            },
            "booking": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "type": "string"
                },
                "workspaceId": {
                  "type": "string"
                },
                "funnelId": {
                  "type": "string"
                },
                "hostId": {
                  "type": "string"
                },
                "teamId": {
                  "type": "string"
                },
                "leadId": {
                  "type": "string"
                },
                "start": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                },
                "end": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                },
                "timeZone": {
                  "type": "string"
                },
                "inviteeTimeZone": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "pending_confirmation",
                    "confirmed",
                    "rescheduled",
                    "cancelled",
                    "expired",
                    "completed",
                    "no_show"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "(Z|[+-][0-9]{2}:[0-9]{2})$"
                }
              }
            },
            "answers": {
              "type": "object",
              "additionalProperties": true
            },
            "attribution": {
              "type": "object",
              "additionalProperties": true
            },
            "test": {
              "type": "boolean",
              "enum": [
                true
              ],
              "description": "Synthetic test event with example data only."
            }
          }
        }
      }
    }
  }
}