Skip to main content
Talk to salesStart

Send Lead Calendar invite

Create a meeting and send invitations to existing CRM Leads and optional explicitly chosen attendees.

POST/api/calendar/{provider}/events
HTTP referenceScope calendar:writeUpdated October 15, 2026

This page documents the canonical HTTP contract for this endpoint.

Conditional availability: these routes require CALENDAR_INTEGRATION_ENABLED=true; otherwise they return 404. Use a signed-in user session or a developer API key with the listed Calendar scope. Access uses the key owner’s own connected personal calendar in the current workspace. Calendar OAuth consent is separate from email consent. Credentials are never returned.

This sends real provider invitations from the caller’s connected account. Recipients are resolved from current CRM Lead and teammate records; guest emails are explicit inputs. In Command Center, sender, recipients, title, description, times, and video-link choice are bound for review and require approval before send. The direct HTTP route executes an explicit authenticated request.

Command Center reads additionally respect CALENDAR_AGENT_READ_ENABLED; agent writes require CALENDAR_AGENT_ENABLED=true. HTTP and CLI availability do not by themselves prove that the harness adapter is enabled. Use capability discovery for the deployed surface.

Path parameters

  • providerrequired

    string

    google or microsoft; use a connected account from the connections response.

Body parameters

  • request_idrequired

    string (UUID)

    Stable request identity for retries of the same event. Use a new UUID for a different invite.

  • lead_id · optional

    string

    One exact current CRM Lead ID; mutually exclusive with lead_ids. At least one CRM Lead is required.

  • lead_ids · optional

    array<string>

    1–25 unique exact CRM Lead IDs when lead_id is omitted.

  • teammate_ids · optional

    array<string>

    Up to 25 exact same-workspace teammate user IDs.

  • guest_emails · optional

    array<string>

    Up to 25 unique explicitly supplied guest emails. The total attendee count cannot exceed 50.

  • titlerequired

    string

    1–250 character event title.

  • description · optional

    string

    Up to 10,000 characters; default empty string.

  • startrequired

    string (date-time)

    Future event start with a UTC offset.

  • endrequired

    string (date-time)

    End with UTC offset, after start and within seven days.

  • add_video_conference · optional

    boolean

    Create the provider’s native Google Meet or Microsoft Teams link; default false.

Errors

StatusMeaning
400Invalid range or provider state, reconnect required, CRM match missing, or event not editable.
401Authentication required.
403The key lacks the required Calendar scope.
404Calendar is disabled, the connection is unavailable, or the event is not found.
409Event version changed; read and review again.
422Invalid request fields.
502Calendar provider request failed.

Docs