Scheduler Zero
REST APIAPI referenceInboxes

Create Gmail connection links

Mint one or more Google authorization links for connecting Gmail / Google Workspace inboxes to this workspace. Adding a mailbox requires interactive Google consent, so this does NOT connect inboxes directly — it returns links a person must open in a browser where they are signed in to Scheduler Zero, choose the Gmail account, and approve access. Each link connects one Gmail account and expires in 2 hours. Requires the `inbox:connect` permission, and the person who opens a link must be a signed-in member of this workspace. The number of links is clamped to the workspace's remaining plan inbox allowance — compare `requested` vs `issued` to see if it was clamped (connecting beyond the plan limit is still possible from the app and is billed as overage).

POST
/inbox/google/connect-links

Mint one or more Google authorization links for connecting Gmail / Google Workspace inboxes to this workspace. Adding a mailbox requires interactive Google consent, so this does NOT connect inboxes directly — it returns links a person must open in a browser where they are signed in to Scheduler Zero, choose the Gmail account, and approve access. Each link connects one Gmail account and expires in 2 hours. Requires the inbox:connect permission, and the person who opens a link must be a signed-in member of this workspace. The number of links is clamped to the workspace's remaining plan inbox allowance — compare requested vs issued to see if it was clamped (connecting beyond the plan limit is still possible from the app and is billed as overage).

Authorization

ApiKeyAuth
x-api-key<token>

API key created under Settings → API Keys. Scoped to a single workspace.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/inbox/google/connect-links" \  -H "Content-Type: application/json" \  -d '{}'
{  "links": [    {      "url": "http://example.com",      "expiresAt": "2019-08-24T14:15:22Z"    }  ],  "requested": 0,  "issued": 0,  "remaining": 0,  "planLimit": 0,  "instructions": "string"}