API reference
258 operations, one page each. The long form for a model is llms-api.txt.
accounts
agent-actions
agents
api-keys
appsumo
audit
automations
- GET /automations
- POST /automations
- GET /automations/{id}
- PATCH /automations/{id}
- DELETE /automations/{id}
- POST /automations/{id}/disable
- POST /automations/{id}/duplicate
- POST /automations/{id}/enable
- GET /automations/{id}/runs
- GET /automations/{id}/runs/{run_id}
- POST /automations/{id}/stop
- GET /automations/{id}/versions
- GET /events
- POST /events
- POST /events/send
- GET /events/{id}
- PATCH /events/{id}
- DELETE /events/{id}
billing
broadcasts
- GET /broadcasts
- POST /broadcasts
- GET /broadcasts/{id}
- PATCH /broadcasts/{id}
- DELETE /broadcasts/{id}
- POST /broadcasts/{id}/archive
- POST /broadcasts/{id}/cancel
- GET /broadcasts/{id}/clicked-links
- POST /broadcasts/{id}/duplicate
- GET /broadcasts/{id}/messages
- GET /broadcasts/{id}/preview
- GET /broadcasts/{id}/recipients
- POST /broadcasts/{id}/send
- GET /broadcasts/{id}/stats
contacts
- GET /audiences/{audienceId}/contacts
- POST /audiences/{audienceId}/contacts
- GET /audiences/{audienceId}/contacts/{id}
- PATCH /audiences/{audienceId}/contacts/{id}
- DELETE /audiences/{audienceId}/contacts/{id}
- GET /contact-properties
- POST /contact-properties
- GET /contact-properties/{id}
- PATCH /contact-properties/{id}
- DELETE /contact-properties/{id}
- GET /contacts
- POST /contacts
- POST /contacts/batch
- GET /contacts/imports
- POST /contacts/imports
- GET /contacts/imports/{id}
- GET /contacts/{id}
- PATCH /contacts/{id}
- DELETE /contacts/{id}
- POST /contacts/{id}/resubscribe
- GET /contacts/{id}/segments
- POST /contacts/{id}/segments/{segment_id}
- DELETE /contacts/{id}/segments/{segment_id}
- GET /contacts/{id}/topics
- PATCH /contacts/{id}/topics
- GET /segments/{id}/contacts
dedicated-ips
deliverability
domains
- GET /domains
- POST /domains
- GET /domains/check
- POST /domains/claim
- GET /domains/setup/{token}
- GET /domains/{id}
- PATCH /domains/{id}
- DELETE /domains/{id}
- GET /domains/{id}/claim
- POST /domains/{id}/claim/verify
- GET /domains/{id}/connect
- GET /domains/{id}/dmarc
- GET /domains/{id}/events
- GET /domains/{id}/inbound-rules
- POST /domains/{id}/inbound-rules
- POST /domains/{id}/inbound-rules/batch/add
- POST /domains/{id}/inbound-rules/batch/remove
- DELETE /domains/{id}/inbound-rules/{rule_id}
- GET /domains/{id}/setup
- POST /domains/{id}/setup-link
- DELETE /domains/{id}/setup-link
- POST /domains/{id}/verify
- GET /domains/{id}/wait
emails
- GET /emails
- POST /emails
- POST /emails/batch
- POST /emails/bulk-cancel
- GET /emails/export.csv
- POST /emails/lint
- POST /emails/preflight
- GET /emails/receiving
- GET /emails/receiving/refusals
- GET /emails/receiving/threads
- GET /emails/receiving/{id}
- DELETE /emails/receiving/{id}
- GET /emails/receiving/{id}/attachments
- GET /emails/receiving/{id}/attachments/{aid}
- GET /emails/receiving/{id}/raw
- POST /emails/receiving/{id}/release
- POST /emails/receiving/{id}/reply
- GET /emails/{id}
- PATCH /emails/{id}
- DELETE /emails/{id}
- GET /emails/{id}/attachments
- GET /emails/{id}/attachments/{aid}
- POST /emails/{id}/cancel
- GET /emails/{id}/eml
- GET /emails/{id}/events
- GET /emails/{id}/explain
- GET /emails/{id}/mime
- POST /emails/{id}/reschedule
- POST /emails/{id}/share
limits
logs
meta
metrics
notifications
oauth
segments
support
- GET /support
- POST /support
- GET /support/answers
- GET /support/answers/{slug}
- POST /support/answers/{slug}/helpful
- GET /support/attachments/{id}/download
- GET /support/config
- GET /support/known-issues
- POST /support/known-issues/{id}/subscribe
- GET /support/search
- POST /support/uploads
- GET /support/{ref}
- POST /support/{ref}/csat
- POST /support/{ref}/messages
- POST /support/{ref}/reopen
- POST /support/{ref}/resolve
suppressions
team
templates
topics
trust
usage
webhooks
- GET /webhooks
- POST /webhooks
- GET /webhooks/{id}
- PATCH /webhooks/{id}
- DELETE /webhooks/{id}
- GET /webhooks/{id}/dead-letters
- GET /webhooks/{id}/deliveries
- GET /webhooks/{id}/events
- GET /webhooks/{id}/events/{event_id}
- GET /webhooks/{id}/events/{event_id}/attempts
- POST /webhooks/{id}/events/{event_id}/replay
- POST /webhooks/{id}/replay
- POST /webhooks/{id}/rotate-secret
- POST /webhooks/{id}/signing-secret/rotate