Overview
Base URL, authentication and conventions of the coss.com HTTP API, with a list of every endpoint by product and resource.
The coss.com API is a JSON API. Every endpoint page in this reference shows the request, every response, and samples for the TypeScript SDK, cURL and the other SDKs.
The machine-readable OpenAPI 3.1 document describes the same
endpoints, and every page is Markdown at its URL plus .md (for
coding agents): /docs/api-reference/emails/send-email.md.
Base URL
https://api.coss.comPaths start with /v1/…. Breaking changes ship as dated API versions, selected with the
Coss-Version header: see Versioning.
Authentication
Send your API key as a bearer token:
curl https://api.coss.com/v1/emails/email_01k7c8m4q2f3e9v6t5r1n0p8yz \
-H "Authorization: Bearer $COSS_API_KEY"The key decides the environment: requests only see data from the key's own environment. See Environments and API keys.
Conventions
- Request and response bodies are JSON (
Content-Type: application/json). Requests are limited to 5 MB, exceptPOST /v1/emails, which accepts up to 40 MB (at most 25 MB of decoded attachments). - Field names are
snake_case; timestamps are ISO 8601 strings in UTC. - IDs are prefixed with their type:
email_…,evt_…. - Every object has an
objectfield naming its type ("email","email_event","list"). - Lists are
{ "object": "list", "data": [...], "has_more": false }. - Every response carries an
X-Request-Idheader (req_…). Include it when contacting support.
All endpoints
Emails
Templates
- List email templates GET
- Create an email template POST
- Retrieve an email template GET
- Update an email template PATCH
- Delete an email template DELETE
- Retrieve a template's draft GET
- Update a template's draft PUT
- Publish a template's draft POST
- Render a template POST
- List a template's versions GET
- Retrieve a template version GET
- Restore a template version POST
Domains
- List sending domains GET
- Add a sending domain POST
- Retrieve a sending domain GET
- Update a sending domain PATCH
- Remove a sending domain DELETE
- Check a domain's DNS records now POST
- Add a custom tracking domain POST
- Remove a custom tracking domain DELETE
- Receive email at a domain POST
- Stop receiving email at a domain DELETE
- Retrieve a domain's DMARC status GET
- List a domain's DMARC reports GET
- Retrieve a DMARC report GET
Dedicated IPs
Suppressions
Tracking
Content storage
Receiving
Inboxes
Endpoints
- List inboxes GET
- Create an inbox POST
- Retrieve an inbox GET
- Update an inbox PATCH
- Delete an inbox DELETE
- List an inbox's threads GET
- Retrieve a thread GET
- Delete a thread DELETE
- List an inbox's messages GET
- Send a message from an inbox POST
- Retrieve a message GET
- Download an attachment of a message GET
- Reply to a message POST
Marketing
Contacts
- List contacts GET
- Create or update a contact POST
- Resend a contact's confirmation email POST
- Create a contact's preference links POST
- Import contacts in bulk POST
- Export contacts as CSV GET
- Retrieve a contact GET
- Update a contact PATCH
- Delete a contact DELETE
- Retrieve a contact's topics GET
- Update a contact's topics PATCH
- List contact properties GET
- Create a contact property POST
- Retrieve a contact property GET
- Update a contact property's fallback PATCH
- Delete a contact property DELETE
Audiences
Segments
Topics
SMS
Endpoints
- List SMS GET
- Send an SMS POST
- List suppressed numbers GET
- Add a number to the SMS suppression list POST
- Check whether a number is suppressed GET
- Retrieve an SMS suppression GET
- Remove a number from the SMS suppression list DELETE
- List received SMS GET
- Retrieve a received SMS GET
- List the organization's phone numbers GET
- Retrieve an SMS GET
- List an SMS's events GET
- Cancel a scheduled SMS POST
Sign
Signature requests
- List signature requests GET
- Create a signature request POST
- Retrieve a signature request GET
- Delete a signature request DELETE
- Send a draft signature request POST
- Cancel a signature request POST
- List a signature request's audit trail GET
- Remind signers POST
- Download the signed document GET
- Create a signing session POST
Templates
Verify
Verifications
Forms
Scheduling
Hosts
Schedules
Out of office
Reassignments
Holiday calendars
Calendars
- Start connecting a calendar POST
- List a host's calendar connections GET
- Connect a calendar with a password POST
- Disconnect a calendar DELETE
- Choose how a calendar counts PATCH
- List calendar delegations GET
- Add a calendar delegation POST
- Get a calendar delegation GET
- Update a calendar delegation PATCH
- Delete a calendar delegation DELETE
- Verify a calendar delegation POST
- List your OAuth apps GET
- Add your own OAuth app POST
- Get an OAuth app GET
- Update an OAuth app PATCH
- Delete an OAuth app DELETE
- Set a simulated calendar's busy times PUT
Event types
Bookings
- Reassign a booking POST
- List who a booking could go to GET
- List bookings GET
- Create a booking POST
- Retrieve a booking GET
- Reschedule a booking POST
- Cancel a booking POST
- List a booking's history GET
- Approve a booking POST
- Decline a booking POST
- List a booking's notifications GET
- Mark a no-show POST
- Set a booking's location PATCH
- Hold a slot POST
- Confirm a hold POST
- Release a hold DELETE
- Erase an attendee DELETE
- Erase an attendee or guest by email POST
- Create a booker session POST
- Create a manage session POST
Hooks
Applications
Event types
Endpoints
Messages
Risk
Endpoints
- List assessments GET
- Assess an event POST
- Retrieve an assessment GET
- Report an assessment's outcome POST
- List allow and block list entries GET
- Add an allow or block list entry POST
- Retrieve a list entry GET
- Remove a list entry DELETE
- Forget a user DELETE
- Retrieve the risk settings GET
- Update the risk settings PATCH
- Retrieve the calibration GET
- List rules GET
- Create a rule POST
- Retrieve a rule GET
- Update a rule PATCH
- Delete a rule DELETE
- Check an email address POST
- Check an IP address POST
- Check a phone number POST
- Classify content POST
- Check a rate limit POST
- List rate limit buckets GET
- Create a rate limit bucket POST
- Retrieve a rate limit bucket GET
- Update a rate limit bucket PATCH
- Delete a rate limit bucket DELETE
Platform
Environment
Webhook endpoints
- List webhook endpoints GET
- Create a webhook endpoint POST
- Retrieve a webhook endpoint GET
- Update a webhook endpoint PATCH
- Delete a webhook endpoint DELETE
- Roll a signing secret POST
- Recover failed deliveries POST
- List an endpoint's deliveries GET
- Retrieve a delivery GET
- Retry a delivery POST
- Open a webhook listener POST
- Poll a webhook listener POST
- Close a webhook listener DELETE
- Send a test event POST
Log drains
Last updated
On This Page