> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.confirm.global/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.confirm.global/_mcp/server.

# Send a calendar-connect link

POST https://api.confirm.global/partner/v1/organizations/{ref}/calendar-invite
Content-Type: application/json

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.


Reference: https://docs.confirm.global/partner-api/organizations/create-calendar-invite

## Authentication

- `Authorization` header (bearer token, required) — 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.

## Request

### Path parameters

- `ref` (string, required) — Your registry identifier (the `external_ref` you created it with).

### Body (application/json)

This endpoint expects an object.

- `email` (string, required) — Who should connect the calendar. Usually the registry's scheduler or office manager.
- `first_name` (string, optional, nullable) — Used to greet the invitee in the email. Omit it or send `null` if unknown; a blank string is rejected.
- `last_name` (string, optional, nullable) — The invitee's last name. Omit it or send `null` if unknown; a blank string is rejected.
- `send_email` (boolean, optional, nullable, default: true) — `false` to skip CONFIRM's email and deliver `invite_url` yourself. Omitted or `null` means `true`.

## Response

### 201

Link created. When a pending, unexpired link already exists for this address in this workspace, you get **200** with that link instead.

- `invite_url` (string, required) — The link the invitee opens to connect a Google or Outlook calendar. No CONFIRM login is needed. Works once.
- `email` (string, required) — The invited address, lowercased.
- `expires_at` (datetime, required) — When the link stops working, 7 days after it was first issued.
- `emailed` (boolean, required) — `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.

## Errors

### 400 Bad Request Error

Invalid request (`error.type: invalid_request_error`, `code: invalid_request`) — missing or malformed fields. `details` lists each offending field.

- `error` (ErrorError, required)

### 401 Unauthorized Error

Missing, malformed, or revoked API key (`error.type: authentication_error`).

- `error` (ErrorError, required)

### 404 Not Found Error

No registry is registered with that ref for your partner account (`unknown_organization_ref`).

- `error` (ErrorError, required)

### 409 Conflict Error

The address already has a CONFIRM account (`email_has_account`), either in another workspace or as a regular user in this one. Invite a different address.

- `error` (ErrorError, required)

### 429 Too Many Requests Error

Rate limit exceeded (`error.type: rate_limit_error`). Design target: 600 requests/min per key, burst 100/10s. Honor the `Retry-After` header.

- `error` (ErrorError, required)

## Types

### ErrorError

- `type` (enum, required) — Broad error category.
  - Allowed values: `authentication_error`, `invalid_request_error`, `not_found_error`, `conflict_error`, `rate_limit_error`, `api_error`
- `code` (string, required) — Machine-readable error code, e.g. `invalid_request`, `unknown_location_ref` or `wrong_environment`. Branch on this; the strings are contract.
- `message` (string, required) — Human-readable explanation.
- `request_id` (string, required) — Identifier for this request — the same value as the response's `X-Request-Id` header. Include it when contacting CONFIRM support.
- `details` (list of ErrorErrorDetailsItems, optional) — Present on `invalid_request` (400): one entry per field that failed validation.
- `location_ref` (string, optional) — Present on `unknown_location_ref` (404) — the reference that wasn't found.
- `organization_ref` (string, optional) — Present on `unknown_organization_ref` (404) — the reference that wasn't found — and on `email_has_account` (409) — the registry the invitation was for.
- `external_ref` (string, optional) — Present on workspace-teardown refusals (403) — the workspace you asked to delete — and on applicant errors (`unknown_candidate_ref`, `no_application_at_location`, `outcome_conflict`) — the applicant ref.
- `organization_refs` (list of string, optional) — Present on `ambiguous_location_ref` (409) — the registries the ref exists in.
- `locations` (list of ErrorErrorLocationsItems, optional) — Present on `location_refs_span_organizations` (400) — each ref you sent with the registry it belongs to.

### ErrorErrorDetailsItems

- `field` (string, required) — Dotted path to the offending field, e.g. `address.postal_code`.
- `message` (string, required) — Why that field was rejected.

### ErrorErrorLocationsItems

- `location_ref` (string, optional)
- `organization_ref` (string, optional, nullable)

## Examples

### emailed

**Response**

```json
{
  "invite_url": "https://app.confirm.global/calendar-connect/4b9e2c71-0d5a-4f83-9a16-7e2c5d8b1f40",
  "email": "scheduling@suncoastnurses.com",
  "expires_at": "2026-10-13T15:20:41.512Z",
  "emailed": true
}
```

**SDK Code**

```python emailed
import requests

url = "https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript emailed
const url = 'https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go emailed
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby emailed
require 'uri'
require 'net/http'

url = URI("https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java emailed
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php emailed
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp emailed
using RestSharp;

var client = new RestClient("https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift emailed
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### CONFIRM emails the link

**Request**

```json
{
  "email": "scheduling@suncoastnurses.com",
  "first_name": "Dana",
  "last_name": "Whitfield"
}
```

**Response**

```json
{
  "invite_url": "https://app.confirm.global/calendar-connect/4b9e2c71-0d5a-4f83-9a16-7e2c5d8b1f40",
  "email": "scheduling@suncoastnurses.com",
  "expires_at": "2026-10-13T15:20:41.512Z",
  "emailed": true
}
```

**SDK Code**

```python CONFIRM emails the link
import requests

url = "https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite"

payload = {
    "email": "scheduling@suncoastnurses.com",
    "first_name": "Dana",
    "last_name": "Whitfield"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript CONFIRM emails the link
const url = 'https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"email":"scheduling@suncoastnurses.com","first_name":"Dana","last_name":"Whitfield"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go CONFIRM emails the link
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite"

	payload := strings.NewReader("{\n  \"email\": \"scheduling@suncoastnurses.com\",\n  \"first_name\": \"Dana\",\n  \"last_name\": \"Whitfield\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby CONFIRM emails the link
require 'uri'
require 'net/http'

url = URI("https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"scheduling@suncoastnurses.com\",\n  \"first_name\": \"Dana\",\n  \"last_name\": \"Whitfield\"\n}"

response = http.request(request)
puts response.read_body
```

```java CONFIRM emails the link
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"scheduling@suncoastnurses.com\",\n  \"first_name\": \"Dana\",\n  \"last_name\": \"Whitfield\"\n}")
  .asString();
```

```php CONFIRM emails the link
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite', [
  'body' => '{
  "email": "scheduling@suncoastnurses.com",
  "first_name": "Dana",
  "last_name": "Whitfield"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp CONFIRM emails the link
using RestSharp;

var client = new RestClient("https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"email\": \"scheduling@suncoastnurses.com\",\n  \"first_name\": \"Dana\",\n  \"last_name\": \"Whitfield\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift CONFIRM emails the link
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "email": "scheduling@suncoastnurses.com",
  "first_name": "Dana",
  "last_name": "Whitfield"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### You deliver the link

**Request**

```json
{
  "email": "scheduling@suncoastnurses.com",
  "send_email": false
}
```

**Response**

```json
{
  "invite_url": "https://app.confirm.global/calendar-connect/4b9e2c71-0d5a-4f83-9a16-7e2c5d8b1f40",
  "email": "scheduling@suncoastnurses.com",
  "expires_at": "2026-10-13T15:20:41.512Z",
  "emailed": true
}
```

**SDK Code**

```python You deliver the link
import requests

url = "https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite"

payload = {
    "email": "scheduling@suncoastnurses.com",
    "send_email": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript You deliver the link
const url = 'https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"email":"scheduling@suncoastnurses.com","send_email":false}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go You deliver the link
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite"

	payload := strings.NewReader("{\n  \"email\": \"scheduling@suncoastnurses.com\",\n  \"send_email\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby You deliver the link
require 'uri'
require 'net/http'

url = URI("https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"scheduling@suncoastnurses.com\",\n  \"send_email\": false\n}"

response = http.request(request)
puts response.read_body
```

```java You deliver the link
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"scheduling@suncoastnurses.com\",\n  \"send_email\": false\n}")
  .asString();
```

```php You deliver the link
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite', [
  'body' => '{
  "email": "scheduling@suncoastnurses.com",
  "send_email": false
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp You deliver the link
using RestSharp;

var client = new RestClient("https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"email\": \"scheduling@suncoastnurses.com\",\n  \"send_email\": false\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift You deliver the link
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "email": "scheduling@suncoastnurses.com",
  "send_email": false
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.confirm.global/partner/v1/organizations/cl_biz_4471/calendar-invite")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```