Information
- OpenAPI version:
3.0.0
Overview
Connect API v2 2026-10-01
Section titled “Connect API v2 2026-10-01”The Connect API sends SMS and email, manages contacts and reports what happened.
Authentication. Send your API key as a Bearer token: Authorization: Bearer <api key>. Keys with Strict API Mode must also sign each request.
Versioning. Send Connect-Version (for example 2026-10-01) to choose a version. Without it, the version set on your API key is used, otherwise the latest. Every response says which version it used.
Idempotency. Send an Idempotency-Key on POST and PATCH requests. Repeating a key within 24 hours returns the original response instead of acting again.
Errors. Errors are returned as application/problem+json with a type, title and detail. Validation errors list the problems by field in errors.
Pagination. Lists return data and nextCursor. Pass nextCursor as cursor for the next page, and limit (1 to 200, default 50) to set the page size.
Authentication
Section titled “Authentication”ApiKeyAuth
Section titled “ApiKeyAuth”Your API key, sent as a Bearer token.
Security scheme type: http