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.
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
E-mails en threads
Verstuur, haal op, doorzoek en beantwoord e-mails en bekijk bezorgevents.
8 operatiesLabels en sorteerregels
Orden verzonden en ontvangen e-mail automatisch of handmatig in mappen.
9 operatiesConcepten en bijlagen
Bouw flows voor het opstellen van berichten met privéopslag voor bijlagen.
10 operatiesGehoste templates
Stel herbruikbare content op, render, test, versioneer, publiceer en verstuur die.
7 operatiesDomeinen
Richt afzenderidentiteiten in en begrijp de status van de DNS-verificatie.
8 operatiesInkomende e-mail
Maak adressen aan en werk met ontvangen gesprekken.
9 operationsDeliverability
Bekijk events, reputatie-uitkomsten en geblokkeerde ontvangers.
10 operationsWebhooks
Receive signed, retried email events (sent, delivered, delayed, bounced, complained, failed, received) at your own endpoints.
47 operationsCampaigns
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 operationsAutomations
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 operationsAccount 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.
{
"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.
{
"version": "2026-09-07",
"baseUrl": "https://sendhq.cc/api/v1",
"openapi": "https://sendhq.cc/openapi.json"
}