Send a calendar-connect link
Issues a link that lets someone connect a calendar to this registry’s workspace without a CONFIRM login.
Why it matters. Screening calls in a workspace are held while it
has no connected calendar, because an applicant who passes is sent a
booking link on that calendar. A workspace you provision starts
without one (calendar.connected: false on the organization). Held
calls go out once a calendar is connected; nothing needs to be
re-sent.
What the invitee does. They open invite_url and connect their
Google or Outlook calendar. They never create a password or sign in
to the portal. If the workspace has no calendar yet, the one they
connect becomes the workspace calendar.
Email. By default CONFIRM emails the link to email. Send
send_email: false to deliver invite_url yourself (for example,
inside your own product). emailed in the response says whether the
email went out: it is false when you turned it off, and also when
sending failed, in which case the link still works and you should
deliver it yourself.
Idempotent per address. 201 creates a new link. 200 returns
the still-pending, unexpired link already issued to the same address
in this workspace, with its original expires_at (and emails it
again unless send_email is false). A link is valid for 7 days and
works once.
Existing accounts. An address that already has a CONFIRM account
returns 409 email_has_account: an account belongs to one workspace,
so the link could not be redeemed. Invite a different address. Someone
who already has an account in this workspace can connect a calendar
from Settings → Integrations in the portal.
Authentication
Partner API key sent as Authorization: Bearer cfk_.... Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.
Path parameters
Your registry identifier (the external_ref you created it with).
Request
Used to greet the invitee in the email. Omit it or send null if unknown; a blank string is rejected.
The invitee’s last name. Omit it or send null if unknown; a blank string is rejected.
false to skip CONFIRM’s email and deliver invite_url yourself. Omitted or null means true.
Response headers
The ID of this request. On an error it equals request_id in the body. If you sent an X-Request-Id, it is your value, returned unchanged. Log it, and quote it when contacting CONFIRM support.
Response
Link created. When a pending, unexpired link already exists for this address in this workspace, you get 200 with that link instead.
true when CONFIRM emailed the link. false when you sent send_email: false, or when the email could not be sent; deliver invite_url yourself in either case.