---
seo:
  description: BillionSend API reference.
sidebar:
  label: Overview
title: BillionSend API
---
Version 1.0.0

Base URL: `https://api.billionsend.com`

## Emails

- [`GET /emails/metrics`](/docs/api-reference/emails/emails-metrics) — Get email metrics.
- [`GET /emails/metrics/links`](/docs/api-reference/emails/emails-metrics-links) — Get clicks by link.
- [`GET /emails/metrics/countries`](/docs/api-reference/emails/emails-metrics-countries) — Get opens and clicks by country.
- [`GET /emails/metrics/clients`](/docs/api-reference/emails/emails-metrics-clients) — Get opens by mail client.
- [`POST /emails/receiving/{id}/reply`](/docs/api-reference/emails/emails-receiving-reply) — Reply to an email.
- [`POST /emails/receiving/{id}/forward`](/docs/api-reference/emails/emails-receiving-forward) — Forward an email.
- [`POST /emails`](/docs/api-reference/emails/emails-send) — Send an email.
- [`GET /emails`](/docs/api-reference/emails/emails-list) — List emails.
- [`POST /emails/batch`](/docs/api-reference/emails/emails-batch) — Send a batch of emails.
- [`POST /emails/{id}/cancel`](/docs/api-reference/emails/emails-cancel) — Cancel an email.
- [`PATCH /emails/{id}`](/docs/api-reference/emails/emails-update) — Update an email.
- [`GET /emails/{id}`](/docs/api-reference/emails/emails-get) — Retrieve an email.
- [`DELETE /emails/{id}`](/docs/api-reference/emails/emails-delete) — Delete an email.
- [`GET /emails/receiving`](/docs/api-reference/emails/emails-receiving-list) — List received emails.
- [`GET /emails/receiving/{id}`](/docs/api-reference/emails/emails-receiving-get) — Get a received email.
- [`DELETE /emails/receiving/{id}`](/docs/api-reference/emails/emails-receiving-delete) — Delete a received email.
- [`GET /emails/receiving/{email_id}/attachments`](/docs/api-reference/emails/emails-receiving-attachments-list) — List attachments.
- [`GET /emails/receiving/{email_id}/attachments/{id}`](/docs/api-reference/emails/emails-receiving-attachments-get) — Get an attachment.
- [`GET /emails/receiving/{email_id}/attachments/{id}/text`](/docs/api-reference/emails/emails-receiving-attachments-text) — Get an attachment's text.
- [`GET /emails/{id}/insights`](/docs/api-reference/emails/emails-insights) — Get email insights.

## Broadcasts

- [`POST /broadcasts`](/docs/api-reference/broadcasts/broadcasts-create) — Create a broadcast.
- [`GET /broadcasts`](/docs/api-reference/broadcasts/broadcasts-list) — List broadcasts.
- [`GET /broadcasts/{id}`](/docs/api-reference/broadcasts/broadcasts-get) — Retrieve a broadcast.
- [`PATCH /broadcasts/{id}`](/docs/api-reference/broadcasts/broadcasts-update) — Update a broadcast.
- [`DELETE /broadcasts/{id}`](/docs/api-reference/broadcasts/broadcasts-delete) — Delete a broadcast.
- [`POST /broadcasts/{id}/send`](/docs/api-reference/broadcasts/broadcasts-send) — Send a broadcast.
- [`POST /broadcasts/{id}/duplicate`](/docs/api-reference/broadcasts/broadcasts-duplicate) — Duplicate a broadcast.
- [`POST /broadcasts/{id}/cancel`](/docs/api-reference/broadcasts/broadcasts-cancel) — Cancel a broadcast.

## Templates

- [`POST /templates`](/docs/api-reference/templates/templates-create) — Create a template.
- [`GET /templates`](/docs/api-reference/templates/templates-list) — List templates.
- [`GET /templates/{id}`](/docs/api-reference/templates/templates-get) — Retrieve a template.
- [`PATCH /templates/{id}`](/docs/api-reference/templates/templates-update) — Update a template.
- [`DELETE /templates/{id}`](/docs/api-reference/templates/templates-delete) — Delete a template.
- [`POST /templates/{id}/publish`](/docs/api-reference/templates/templates-publish) — Publish a template.
- [`POST /templates/{id}/duplicate`](/docs/api-reference/templates/templates-duplicate) — Duplicate a template.

## Domains

- [`POST /domains`](/docs/api-reference/domains/domains-create) — Create a domain.
- [`GET /domains`](/docs/api-reference/domains/domains-list) — List domains.
- [`GET /domains/{id}`](/docs/api-reference/domains/domains-get) — Retrieve a domain.
- [`PATCH /domains/{id}`](/docs/api-reference/domains/domains-update) — Update a domain.
- [`DELETE /domains/{id}`](/docs/api-reference/domains/domains-delete) — Delete a domain.
- [`POST /domains/{id}/verify`](/docs/api-reference/domains/domains-verify) — Verify a domain.

## Contacts

- [`POST /contacts`](/docs/api-reference/contacts/contacts-create) — Create a contact.
- [`GET /contacts`](/docs/api-reference/contacts/contacts-list) — List contacts.
- [`POST /contacts/batch/get`](/docs/api-reference/contacts/contacts-batch-get) — Read contacts in bulk.
- [`POST /contacts/batch/remove`](/docs/api-reference/contacts/contacts-batch-remove) — Delete in bulk.
- [`POST /contacts/batch`](/docs/api-reference/contacts/contacts-batch-create) — Create in bulk.
- [`GET /contacts/{id}`](/docs/api-reference/contacts/contacts-get) — Retrieve a contact.
- [`PATCH /contacts/{id}`](/docs/api-reference/contacts/contacts-update) — Update a contact.
- [`DELETE /contacts/{id}`](/docs/api-reference/contacts/contacts-delete) — Delete a contact.
- [`POST /contacts/{id}/preferences-link`](/docs/api-reference/contacts/contacts-preferences-link) — Get a preferences link.
- [`GET /contacts/{id}/topics`](/docs/api-reference/contacts/contacts-topics-list) — List contact topics.
- [`PATCH /contacts/{id}/topics`](/docs/api-reference/contacts/contacts-topics-update) — Update contact topics.
- [`POST /contacts/{id}/segments/{segmentId}`](/docs/api-reference/contacts/contacts-segments-add) — Add to a segment.
- [`DELETE /contacts/{id}/segments/{segmentId}`](/docs/api-reference/contacts/contacts-segments-remove) — Leave a segment.

## Segments

- [`POST /segments`](/docs/api-reference/segments/segments-create) — Create a segment.
- [`GET /segments`](/docs/api-reference/segments/segments-list) — List segments.
- [`GET /segments/{id}`](/docs/api-reference/segments/segments-get) — Retrieve a segment.
- [`PATCH /segments/{id}`](/docs/api-reference/segments/segments-update) — Update a segment.
- [`DELETE /segments/{id}`](/docs/api-reference/segments/segments-delete) — Delete a segment.
- [`GET /segments/{id}/contacts`](/docs/api-reference/segments/segments-contacts-list) — List segment contacts.

## Topics

- [`POST /topics`](/docs/api-reference/topics/topics-create) — Create a topic.
- [`GET /topics`](/docs/api-reference/topics/topics-list) — List topics.
- [`GET /topics/{id}`](/docs/api-reference/topics/topics-get) — Retrieve a topic.
- [`PATCH /topics/{id}`](/docs/api-reference/topics/topics-update) — Update a topic.
- [`DELETE /topics/{id}`](/docs/api-reference/topics/topics-delete) — Delete a topic.

## Contact properties

- [`POST /contact-properties`](/docs/api-reference/contact-properties/contact-properties-create) — Create a property.
- [`GET /contact-properties`](/docs/api-reference/contact-properties/contact-properties-list) — List properties.
- [`GET /contact-properties/{id}`](/docs/api-reference/contact-properties/contact-properties-get) — Retrieve a property.
- [`PATCH /contact-properties/{id}`](/docs/api-reference/contact-properties/contact-properties-update) — Update a property.
- [`DELETE /contact-properties/{id}`](/docs/api-reference/contact-properties/contact-properties-delete) — Delete a property.

## Audiences

- [`POST /audiences/{audienceId}/contacts`](/docs/api-reference/audiences/audiences-contacts-create) — Create a contact.
- [`GET /audiences/{audienceId}/contacts/{id}`](/docs/api-reference/audiences/audiences-contacts-get) — Retrieve a contact.
- [`PATCH /audiences/{audienceId}/contacts/{id}`](/docs/api-reference/audiences/audiences-contacts-update) — Update a contact.
- [`DELETE /audiences/{audienceId}/contacts/{id}`](/docs/api-reference/audiences/audiences-contacts-delete) — Delete a contact.

## Unsubscribes

- [`GET /unsubscribes`](/docs/api-reference/unsubscribes/unsubscribes-list) — List unsubscribes.
- [`POST /unsubscribes`](/docs/api-reference/unsubscribes/unsubscribes-create) — Record an unsubscribe.
- [`DELETE /unsubscribes/{id}`](/docs/api-reference/unsubscribes/unsubscribes-delete) — Delete an unsubscribe.

## Suppressions

- [`POST /suppressions/batch/add`](/docs/api-reference/suppressions/suppressions-batch-add) — Add in bulk.
- [`POST /suppressions/batch/remove`](/docs/api-reference/suppressions/suppressions-batch-remove) — Remove in bulk.
- [`POST /suppressions`](/docs/api-reference/suppressions/suppressions-create) — Add a suppression.
- [`GET /suppressions`](/docs/api-reference/suppressions/suppressions-list) — List suppressions.
- [`GET /suppressions/{id}`](/docs/api-reference/suppressions/suppressions-get) — Retrieve a suppression.
- [`DELETE /suppressions/{id}`](/docs/api-reference/suppressions/suppressions-delete) — Remove a suppression.

## Webhooks

- [`POST /webhooks`](/docs/api-reference/webhooks/webhooks-create) — Create a webhook.
- [`GET /webhooks`](/docs/api-reference/webhooks/webhooks-list) — List webhooks.
- [`GET /webhooks/{id}`](/docs/api-reference/webhooks/webhooks-get) — Retrieve a webhook.
- [`PATCH /webhooks/{id}`](/docs/api-reference/webhooks/webhooks-update) — Update a webhook.
- [`DELETE /webhooks/{id}`](/docs/api-reference/webhooks/webhooks-delete) — Delete a webhook.
- [`POST /webhooks/{id}/rotate`](/docs/api-reference/webhooks/webhooks-rotate) — Rotate signing secret.

## API keys

- [`POST /api-keys`](/docs/api-reference/api-keys/api-keys-create) — Create an API key.
- [`GET /api-keys`](/docs/api-reference/api-keys/api-keys-list) — List API keys.
- [`DELETE /api-keys/{id}`](/docs/api-reference/api-keys/api-keys-delete) — Delete an API key.

## Inboxes

- [`GET /inboxes/events`](/docs/api-reference/inboxes/inboxes-events-stream) — Stream inbox events.
- [`GET /inboxes/{inbox_id}/events`](/docs/api-reference/inboxes/inboxes-events-stream-inbox) — Stream one inbox's events.
- [`POST /inboxes`](/docs/api-reference/inboxes/inboxes-create) — Create an inbox.
- [`GET /inboxes`](/docs/api-reference/inboxes/inboxes-list) — List inboxes.
- [`GET /inboxes/{inbox_id}`](/docs/api-reference/inboxes/inboxes-get) — Retrieve an inbox.
- [`PATCH /inboxes/{inbox_id}`](/docs/api-reference/inboxes/inboxes-update) — Update an inbox.
- [`DELETE /inboxes/{inbox_id}`](/docs/api-reference/inboxes/inboxes-delete) — Delete an inbox.
- [`GET /inboxes/{inbox_id}/agent`](/docs/api-reference/inboxes/inboxes-agent-get) — Get agent settings.
- [`GET /inboxes/{inbox_id}/safety`](/docs/api-reference/inboxes/inboxes-safety-get) — Get safety rules.
- [`PATCH /inboxes/{inbox_id}/safety`](/docs/api-reference/inboxes/inboxes-safety-update) — Update safety rules.
- [`GET /inboxes/{inbox_id}/labels`](/docs/api-reference/inboxes/inboxes-labels-list) — List an inbox's labels.
- [`POST /inboxes/{inbox_id}/labels`](/docs/api-reference/inboxes/inboxes-labels-create) — Create a label.
- [`PATCH /inboxes/{inbox_id}/labels/{label_id}`](/docs/api-reference/inboxes/inboxes-labels-update) — Update a label.
- [`DELETE /inboxes/{inbox_id}/labels/{label_id}`](/docs/api-reference/inboxes/inboxes-labels-delete) — Delete a label.
- [`GET /inboxes/{inbox_id}/threads/search`](/docs/api-reference/inboxes/inboxes-threads-search) — Search threads.
- [`GET /inboxes/{inbox_id}/threads`](/docs/api-reference/inboxes/inboxes-threads-list) — List threads.
- [`GET /inboxes/{inbox_id}/threads/{thread_id}`](/docs/api-reference/inboxes/inboxes-threads-get) — Retrieve a thread.
- [`PATCH /inboxes/{inbox_id}/threads/{thread_id}`](/docs/api-reference/inboxes/inboxes-threads-update) — Update a thread.
- [`DELETE /inboxes/{inbox_id}/threads/{thread_id}`](/docs/api-reference/inboxes/inboxes-threads-delete) — Delete a thread.
- [`POST /inboxes/{inbox_id}/threads/{thread_id}/labels`](/docs/api-reference/inboxes/inboxes-threads-labels-add) — Add labels to a thread.
- [`PUT /inboxes/{inbox_id}/threads/{thread_id}/labels`](/docs/api-reference/inboxes/inboxes-threads-labels-set) — Set a thread's labels.
- [`DELETE /inboxes/{inbox_id}/threads/{thread_id}/labels/{label_id}`](/docs/api-reference/inboxes/inboxes-threads-labels-remove) — Remove a thread label.
- [`GET /inboxes/{inbox_id}/threads/{thread_id}/emails`](/docs/api-reference/inboxes/inboxes-threads-emails-list) — List a thread's emails.
- [`GET /inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}`](/docs/api-reference/inboxes/inboxes-threads-emails-get) — Get a thread email.
- [`GET /inboxes/{inbox_id}/quarantine`](/docs/api-reference/inboxes/inboxes-quarantine-list) — List quarantine.
- [`POST /inboxes/{inbox_id}/quarantine/{email_id}/release`](/docs/api-reference/inboxes/inboxes-quarantine-release) — Release an email.
- [`GET /inboxes/{inbox_id}/codes/latest`](/docs/api-reference/inboxes/inboxes-codes-latest) — Get latest code.
- [`POST /inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}/reply`](/docs/api-reference/inboxes/inboxes-threads-emails-reply) — Reply in a thread.
- [`POST /inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}/forward`](/docs/api-reference/inboxes/inboxes-threads-emails-forward) — Forward a thread email.
- [`POST /inboxes/{inbox_id}/emails`](/docs/api-reference/inboxes/inboxes-send) — Send an email from an inbox.
- [`POST /inboxes/{inbox_id}/drafts`](/docs/api-reference/inboxes/inboxes-drafts-create) — Create a draft.
- [`GET /inboxes/{inbox_id}/drafts`](/docs/api-reference/inboxes/inboxes-drafts-list) — List drafts.
- [`GET /inboxes/{inbox_id}/drafts/{draft_id}`](/docs/api-reference/inboxes/inboxes-drafts-get) — Retrieve a draft.
- [`PATCH /inboxes/{inbox_id}/drafts/{draft_id}`](/docs/api-reference/inboxes/inboxes-drafts-update) — Update a draft.
- [`DELETE /inboxes/{inbox_id}/drafts/{draft_id}`](/docs/api-reference/inboxes/inboxes-drafts-delete) — Delete a draft.
- [`POST /inboxes/{inbox_id}/drafts/{draft_id}/send`](/docs/api-reference/inboxes/inboxes-drafts-send) — Send a draft.
- [`POST /inboxes/{inbox_id}/drafts/{draft_id}/reject`](/docs/api-reference/inboxes/inboxes-drafts-reject) — Reject a draft.

## Agent

- [`POST /agent/signup`](/docs/api-reference/agent/agent-signup) — Sign up as an agent.
- [`GET /agent/status`](/docs/api-reference/agent/agent-status) — Get the account's claim status.
- [`POST /agent/claim-email`](/docs/api-reference/agent/agent-claim-email) — Send the claim link again.

## Usage

- [`GET /usage`](/docs/api-reference/usage/usage-get) — Get usage.

## Deliverability

- [`GET /deliverability`](/docs/api-reference/deliverability/deliverability-get) — Get deliverability.

## Verifications

- [`GET /verifications/availability`](/docs/api-reference/verifications/verifications-availability) — Check verification availability.
- [`POST /verifications/estimate`](/docs/api-reference/verifications/verifications-estimate) — Estimate a verification.
- [`POST /verifications`](/docs/api-reference/verifications/verifications-create) — Start a verification.
- [`GET /verifications`](/docs/api-reference/verifications/verifications-list) — List verifications.
- [`GET /verifications/{id}`](/docs/api-reference/verifications/verifications-get) — Retrieve a verification.
