Schedule a new calendar event with optional attendee invitations
Schedule a new calendar event with optional attendee invitations, location, and auto-generated Google Meet video conference links on the connected Google account, or 2 if a Meet link is successfully created)
Request
- x-api-key: <your-api-key>
- Content-Type: application/json
Response
200 OKmockfrom 1 token
{
"event": {
"attendees": [
{}
],
"end": {},
"htmlLink": "https://example.com/page",
"id": "msg_792407",
"start": {},
"summary": "A short summary."
},
"meetLink": "https://example.com/page",
"meetLinkStatus": "success",
"status": "success",
"tokensDeducted": 1
}
The response below is a mock built from the endpoint's own schema — no request leaves this page. Edit the body, press Send, read the shape you will get back.
Run it for real in the dashboard →
What it does
Schedule a new calendar event with optional attendee invitations, location, and auto-generated Google Meet video conference links on the connected Google account, or 2 if a Meet link is successfully created)
Request
Body
| Field | Type | Required | Description |
|---|---|---|---|
accountId | string | no | Which connected Google account to use, when more than one is connected |
attendees | array<object> | no | |
↳ displayName | string | no | |
↳ email | string | yes | |
↳ optional | boolean | no | |
calendarId | string | no | |
createGoogleMeet | boolean | no | If true, automatically provisions a Google Meet video conference link for the event. |
description | string | no | |
end | object | yes | |
↳ date | string | no | |
↳ dateTime | string | no | |
↳ timeZone | string | no | |
location | string | no | |
sendUpdates | enum | no | Send email notifications to attendees. Defaults to none, since scheduling an event should not silently email people. One of: all, externalOnly, none. |
start | object | yes | ISO 8601 dateTime (e.g., 2026-08-01T10:00:00Z) or YYYY-MM-DD date for all-day events |
↳ date | string | no | |
↳ dateTime | string | no | |
↳ timeZone | string | no | |
summary | string | yes |
Example request
{
"accountId": "acc_182428",
"attendees": [
{
"displayName": "Ada Lovelace",
"email": "ada@example.com",
"optional": false
}
],
"calendarId": "primary",
"createGoogleMeet": false,
"description": "Generated from the endpoint's own schema.",
"end": {
"date": "2026-09-08",
"dateTime": "2026-09-08T10:00:00Z",
"timeZone": "Europe/Warsaw"
},
"location": "<location>",
"sendUpdates": "none",
"start": {
"date": "2026-09-08",
"dateTime": "2026-09-08T10:00:00Z",
"timeZone": "Europe/Warsaw"
},
"summary": "A short summary."
}Response
| Field | Type | Description |
|---|---|---|
event | object | |
↳ attendees | array<object> | |
↳ end | object | |
↳ htmlLink | string | |
↳ id | string | |
↳ start | object | |
↳ summary | string | |
meetLink | string | |
meetLinkStatus | enum | One of: success, pending, failure, unknown, not_requested. |
status | string | |
tokensDeducted | integer |
Example response
{
"event": {
"attendees": [
{}
],
"end": {},
"htmlLink": "https://example.com/page",
"id": "msg_792407",
"start": {},
"summary": "A short summary."
},
"meetLink": "https://example.com/page",
"meetLinkStatus": "success",
"status": "success",
"tokensDeducted": 1
}Errors
Every error answers with the same envelope: an HTTP status, a machine code and a sentence.
400 | The body or a parameter failed validation. The details array names the field. |
401 | No key, a revoked key or a wrong header. Send x-api-key. |
402 | The wallet cannot cover this call. Top up or wait for the monthly grant. |
404 | The resource does not exist, or it is not yours. Both answer identically and cost nothing. |
429 | Over the per-minute quota of your tier. Back off and retry. |
5xx | Upstream refused or timed out. The call is not billed. |
Code
curl -X POST 'https://app.castomapi.com/v1/google/calendar/events/create' \
-H 'x-api-key: <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{"accountId": "acc_182428", "attendees": [{"displayName": "Ada Lovelace", "email": "ada@example.com", "optional": false}], "calendarId": "primary", "createGoogleMeet": false, "description": "Generated from the endpoint's own schema.", "end": {"date": "2026-09-08", "dateTime": "2026-09-08T10:00:00Z", "timeZone": "Europe/Warsaw"}, "location": "<location>", "sendUpdates": "none", "start": {"date": "2026-09-08", "dateTime": "2026-09-08T10:00:00Z", "timeZone": "Europe/Warsaw"}, "summary": "A short summary."}'const res = await fetch('https://app.castomapi.com/v1/google/calendar/events/create', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"accountId": "acc_182428", "attendees": [{"displayName": "Ada Lovelace", "email": "ada@example.com", "optional": false}], "calendarId": "primary", "createGoogleMeet": false, "description": "Generated from the endpoint's own schema.", "end": {"date": "2026-09-08", "dateTime": "2026-09-08T10:00:00Z", "timeZone": "Europe/Warsaw"}, "location": "<location>", "sendUpdates": "none", "start": {"date": "2026-09-08", "dateTime": "2026-09-08T10:00:00Z", "timeZone": "Europe/Warsaw"}, "summary": "A short summary."})
});
const data = await res.json();
console.log(data);import { request } from 'node:https';
// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/google/calendar/events/create', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"accountId": "acc_182428", "attendees": [{"displayName": "Ada Lovelace", "email": "ada@example.com", "optional": false}], "calendarId": "primary", "createGoogleMeet": false, "description": "Generated from the endpoint's own schema.", "end": {"date": "2026-09-08", "dateTime": "2026-09-08T10:00:00Z", "timeZone": "Europe/Warsaw"}, "location": "<location>", "sendUpdates": "none", "start": {"date": "2026-09-08", "dateTime": "2026-09-08T10:00:00Z", "timeZone": "Europe/Warsaw"}, "summary": "A short summary."})
});
const data = await res.json();
console.log(data);import requests
res = requests.post(
'https://app.castomapi.com/v1/google/calendar/events/create',
headers={'x-api-key': '<your-api-key>'},
json={"accountId": "acc_182428", "attendees": [{"displayName": "Ada Lovelace", "email": "ada@example.com", "optional": False}], "calendarId": "primary", "createGoogleMeet": False, "description": "Generated from the endpoint's own schema.", "end": {"date": "2026-09-08", "dateTime": "2026-09-08T10:00:00Z", "timeZone": "Europe/Warsaw"}, "location": "<location>", "sendUpdates": "none", "start": {"date": "2026-09-08", "dateTime": "2026-09-08T10:00:00Z", "timeZone": "Europe/Warsaw"}, "summary": "A short summary."},
timeout=30,
)
print(res.json())<?php
$ch = curl_init('https://app.castomapi.com/v1/google/calendar/events/create');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode(['accountId' => 'acc_182428', 'attendees' => [['displayName' => 'Ada Lovelace', 'email' => 'ada@example.com', 'optional' => false]], 'calendarId' => 'primary', 'createGoogleMeet' => false, 'description' => 'Generated from the endpoint\'s own schema.', 'end' => ['date' => '2026-09-08', 'dateTime' => '2026-09-08T10:00:00Z', 'timeZone' => 'Europe/Warsaw'], 'location' => '<location>', 'sendUpdates' => 'none', 'start' => ['date' => '2026-09-08', 'dateTime' => '2026-09-08T10:00:00Z', 'timeZone' => 'Europe/Warsaw'], 'summary' => 'A short summary.']),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);Cost and limits
This operation costs from 1 token. A call that fails is never billed. Every account gets 1000 free tokens a month; paid balances never expire. 1 token, or 2 when a Meet link is created with the event.
Rate limits per minute
| No key | 10 |
| Free | 60 |
| Pro | 300 |
| Enterprise | 1200 |
Questions
What does Schedule a new calendar event with optional attendee invitations cost?
from 1 token per successful call, debited from your wallet after the response. Failed calls are free. Every account receives 1000 free tokens a month. 1 token, or 2 when a Meet link is created with the event.
How do I authenticate?
Send your key in the x-api-key header. One key covers every metered endpoint; there is nothing to enable per endpoint.
Can I send an Authorization: Bearer token instead?
Not for a metered endpoint — those take the x-api-key header and nothing else. Bearer tokens belong to the account side: the dashboard and account APIs accept a JWT session, and castomapi-auth issues those through a standard OAuth2 handshake, with authorization code, client credentials and refresh grants. The auth service page covers it.
What are the limits?
10 requests a minute per IP with no key at all, 60 a minute on the free tier, 300 on Pro, 1200 on Enterprise. Above the no-key tier the quota is per account, across every endpoint.
OpenAPI: https://app.castomapi.com/docs/json