API-referentie

Eén contract voor alles wat klanten kunnen gebruiken.

Endpoints voor klanten zijn beschikbaar onder /api/v1. Het oude prefix /api blijft beschikbaar voor het dashboard, maar nieuwe serverintegraties horen de base-URL met versienummer te gebruiken.

163 documented operations11 resource groupsOpenAPI 3.1 machine-readable contract

Grenzen van authenticatie

Productintegraties gebruiken een API-sleutel van de workspace, waarmee je ook accountgebruik, analytics en metadata van API-sleutels kunt lezen. Wijzigingen in de facturering en het aanmaken of intrekken van API-sleutels vereisen de HTTP-only browsersessie en zijn als zodanig gelabeld.

Resources

10 operations

E-mails en threads

Verstuur, haal op, doorzoek en beantwoord e-mails en bekijk bezorgevents.

8 operaties

Labels en sorteerregels

Orden verzonden en ontvangen e-mail automatisch of handmatig in mappen.

9 operaties

Concepten en bijlagen

Bouw flows voor het opstellen van berichten met privéopslag voor bijlagen.

10 operaties

Gehoste templates

Stel herbruikbare content op, render, test, versioneer, publiceer en verstuur die.

7 operaties

Domeinen

Richt afzenderidentiteiten in en begrijp de status van de DNS-verificatie.

8 operaties

Inkomende e-mail

Maak adressen aan en werk met ontvangen gesprekken.

9 operations

Deliverability

Bekijk events, reputatie-uitkomsten en geblokkeerde ontvangers.

10 operations

Webhooks

Receive signed, retried email events (sent, delivered, delayed, bounced, complained, failed, received) at your own endpoints.

47 operations

Campaigns

Store contacts with their consent basis, tags, and custom fields, organize them into lists with hosted double opt-in signup forms, welcome emails, and public newsletter sites, target segments, import and export CSV files, and send, test, and schedule broadcasts with merge tags, per-list one-click unsubscribe, pre-send checks, bot-filtered open and click reports, and per-recipient outcomes.

36 operations

Automations

Record what contacts do as events, and run timed sequences of emails that start on an event, stop when the contact converts, and share per-person sending limits. Create and edit automations, their emails and language versions, turn them on and off, and add or remove people. Available to enabled workspaces.

9 operations

Account en facturering

Lees accountgebruik, analytics en sleutelmetadata met een API-sleutel; wijzigingen in de facturering en het aanmaken of intrekken van sleutels vereisen een dashboardsessie.

Foutenvelope

JSON-fouten gebruiken één voorspelbare envelope. Statuscodes maken onderscheid tussen ongeldige input, authenticatie, ontbrekende resources, conflicten, betalingsvereisten, veiligheidsblokkades en gebruikslimieten.

Foutrespons
{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

Versiebeheer

De datumgebaseerde API-versie identificeert dit contract. Binnen de versie kunnen achterwaarts compatibele velden worden toegevoegd. Brekende wijzigingen vereisen een nieuw basispad met versienummer en een gedocumenteerde overgang.

Discovery
{
  "version": "2026-09-07",
  "baseUrl": "https://sendhq.cc/api/v1",
  "openapi": "https://sendhq.cc/openapi.json"
}