API reference

Download: https://thealtermeai.com/openapi/email-v1.yaml (same file as /openapi/email-v1.yaml on this site). Point Cursor, Claude, or another agent at that URL, then follow Authentication for the key.

REST calls use https://api.thealtermeai.com. The OpenAPI file is not on the API host — https://api.thealtermeai.com/openapi/email-v1.yaml will 404. Local dev: http://localhost:3000/openapi/email-v1.yaml.

Guide

• GET/api/v1/email/organizationAny valid key

  Organization, key scopes, allowance, and warm-up

Guide

• GET/api/v1/email/audiencesaudiences:read

  List audiences

• POST/api/v1/email/audiencesaudiences:write

  Create an audience

• GET/api/v1/email/audiences/{audienceId}audiences:read

  Get an audience

• PATCH/api/v1/email/audiences/{audienceId}audiences:write

  Update an audience

• DELETE/api/v1/email/audiences/{audienceId}audiences:write

  Delete an audience

Guide

• GET/api/v1/email/contactscontacts:read

  List contacts

• POST/api/v1/email/contactscontacts:write

  Create or update a contact

• GET/api/v1/email/contacts/{contactId}contacts:read

  Get a contact

• PATCH/api/v1/email/contacts/{contactId}contacts:write

  Update a contact

• DELETE/api/v1/email/contacts/{contactId}contacts:write

  Delete a contact

Guide

• POST/api/v1/email/contacts/batchcontacts:write

  Upsert up to 500 contacts into one audience

Guide

• GET/api/v1/email/templatestemplates:read

  List templates

• POST/api/v1/email/templatestemplates:write

  Create a template

• GET/api/v1/email/templates/{templateId}templates:read

  Get a template (optional HTML bodies)

• PATCH/api/v1/email/templates/{templateId}templates:write

  Update or archive a template

Guide

• GET/api/v1/email/sender-identitiescampaigns:read

  List From addresses and domain verification status

• POST/api/v1/email/sender-identitiescampaigns:write

  Create a sender identity (From name + email on a verified domain)

Guide

• GET/api/v1/email/campaignscampaigns:read

  List campaigns

• POST/api/v1/email/campaignscampaigns:write

  Create a draft campaign

• GET/api/v1/email/campaigns/{campaignId}campaigns:read

  Get a campaign

• PATCH/api/v1/email/campaigns/{campaignId}campaigns:write

  Update a draft campaign

• POST/api/v1/email/campaigns/{campaignId}/sendcampaigns:write

  Send a campaign

Guide

• GET/api/v1/email/messagesmessages:read

  List transactional sends

• POST/api/v1/email/messagesmessages:write

  Send a transactional message

• GET/api/v1/email/messages/{messageId}messages:read

  Get a transactional send

• DELETE/api/v1/email/messages/{messageId}messages:write

  Cancel a scheduled send

Guide

• GET/api/v1/email/webhookswebhooks:read

  List webhook endpoints

• POST/api/v1/email/webhookswebhooks:write

  Create a webhook endpoint

• GET/api/v1/email/webhooks/{endpointId}webhooks:read

  Get a webhook endpoint

• PATCH/api/v1/email/webhooks/{endpointId}webhooks:write

  Update URL, events, or status

• DELETE/api/v1/email/webhooks/{endpointId}webhooks:write

  Delete a webhook endpoint

• POST/api/v1/email/webhooks/{endpointId}/rotate-secretwebhooks:write

  Rotate signing secret (returned once)

Guide

• GET/api/v1/email/conversionsconversions:read

  List conversion events

• POST/api/v1/email/conversionsconversions:write

  Record a conversion

Event subscriptions are managed in the app. See Webhooks.