BillionSend API
Send and receive email, manage contacts and broadcasts, and read delivery events and statistics. Authenticate with a bs_ API key sent as a Bearer token.
Versión 1.0.0
URL base
https://api.billionsend.comEmails
- GETGet email metrics
/emails/metrics - GETGet clicks by link
/emails/metrics/links - GETGet opens and clicks by country
/emails/metrics/countries - GETGet opens by mail client
/emails/metrics/clients - POSTReply to an email
/emails/receiving/{id}/reply - POSTForward an email
/emails/receiving/{id}/forward - POSTSend an email
/emails - GETList emails
/emails - POSTSend a batch of emails
/emails/batch - POSTCancel an email
/emails/{id}/cancel - PATCHUpdate an email
/emails/{id} - GETRetrieve an email
/emails/{id} - DELETEDelete an email
/emails/{id} - GETList received emails
/emails/receiving - GETGet a received email
/emails/receiving/{id} - DELETEDelete a received email
/emails/receiving/{id} - GETList attachments
/emails/receiving/{email_id}/attachments - GETGet an attachment
/emails/receiving/{email_id}/attachments/{id} - GETGet an attachment's text
/emails/receiving/{email_id}/attachments/{id}/text - GETGet email insights
/emails/{id}/insights
Broadcasts
- POSTCreate a broadcast
/broadcasts - GETList broadcasts
/broadcasts - GETRetrieve a broadcast
/broadcasts/{id} - PATCHUpdate a broadcast
/broadcasts/{id} - DELETEDelete a broadcast
/broadcasts/{id} - POSTSend a broadcast
/broadcasts/{id}/send - POSTDuplicate a broadcast
/broadcasts/{id}/duplicate - POSTCancel a broadcast
/broadcasts/{id}/cancel
Templates
- POSTCreate a template
/templates - GETList templates
/templates - GETRetrieve a template
/templates/{id} - PATCHUpdate a template
/templates/{id} - DELETEDelete a template
/templates/{id} - POSTPublish a template
/templates/{id}/publish - POSTDuplicate a template
/templates/{id}/duplicate
Domains
- POSTCreate a domain
/domains - GETList domains
/domains - GETRetrieve a domain
/domains/{id} - PATCHUpdate a domain
/domains/{id} - DELETEDelete a domain
/domains/{id} - POSTVerify a domain
/domains/{id}/verify
Contacts
- POSTCreate a contact
/contacts - GETList contacts
/contacts - POSTRead contacts in bulk
/contacts/batch/get - POSTDelete contacts in bulk
/contacts/batch/remove - POSTCreate contacts in bulk
/contacts/batch - GETRetrieve a contact
/contacts/{id} - PATCHUpdate a contact
/contacts/{id} - DELETEDelete a contact
/contacts/{id} - POSTGet a preferences link
/contacts/{id}/preferences-link - GETList contact topics
/contacts/{id}/topics - PATCHUpdate contact topics
/contacts/{id}/topics - POSTAdd to a segment
/contacts/{id}/segments/{segmentId} - DELETELeave a segment
/contacts/{id}/segments/{segmentId}
Segments
- POSTCreate a segment
/segments - GETList segments
/segments - GETRetrieve a segment
/segments/{id} - PATCHUpdate a segment
/segments/{id} - DELETEDelete a segment
/segments/{id} - GETList segment contacts
/segments/{id}/contacts
Topics
- POSTCreate a topic
/topics - GETList topics
/topics - GETRetrieve a topic
/topics/{id} - PATCHUpdate a topic
/topics/{id} - DELETEDelete a topic
/topics/{id}
Contact properties
- POSTCreate a property
/contact-properties - GETList properties
/contact-properties - GETRetrieve a property
/contact-properties/{id} - PATCHUpdate a property
/contact-properties/{id} - DELETEDelete a property
/contact-properties/{id}
Audiences
- POSTCreate a contact in an audience
/audiences/{audienceId}/contacts - GETRetrieve a contact in an audience
/audiences/{audienceId}/contacts/{id} - PATCHUpdate a contact in an audience
/audiences/{audienceId}/contacts/{id} - DELETEDelete a contact from an audience
/audiences/{audienceId}/contacts/{id}
Unsubscribes
- GETList unsubscribes
/unsubscribes - POSTRecord an unsubscribe
/unsubscribes - DELETEDelete an unsubscribe
/unsubscribes/{id}
Suppressions
- POSTAdd suppressions in bulk
/suppressions/batch/add - POSTRemove suppressions in bulk
/suppressions/batch/remove - POSTAdd a suppression
/suppressions - GETList suppressions
/suppressions - GETRetrieve a suppression
/suppressions/{id} - DELETERemove a suppression
/suppressions/{id}
Webhooks
- POSTCreate a webhook
/webhooks - GETList webhooks
/webhooks - GETRetrieve a webhook
/webhooks/{id} - PATCHUpdate a webhook
/webhooks/{id} - DELETEDelete a webhook
/webhooks/{id} - POSTRotate signing secret
/webhooks/{id}/rotate
API keys
Inboxes
- GETStream inbox events
/inboxes/events - GETStream one inbox's events
/inboxes/{inbox_id}/events - POSTCreate an inbox
/inboxes - GETList inboxes
/inboxes - GETRetrieve an inbox
/inboxes/{inbox_id} - PATCHUpdate an inbox
/inboxes/{inbox_id} - DELETEDelete an inbox
/inboxes/{inbox_id} - GETGet agent settings
/inboxes/{inbox_id}/agent - GETGet safety rules
/inboxes/{inbox_id}/safety - PATCHUpdate safety rules
/inboxes/{inbox_id}/safety - GETList an inbox's labels
/inboxes/{inbox_id}/labels - POSTCreate a label
/inboxes/{inbox_id}/labels - PATCHUpdate a label
/inboxes/{inbox_id}/labels/{label_id} - DELETEDelete a label
/inboxes/{inbox_id}/labels/{label_id} - GETSearch threads
/inboxes/{inbox_id}/threads/search - GETList threads
/inboxes/{inbox_id}/threads - GETRetrieve a thread
/inboxes/{inbox_id}/threads/{thread_id} - PATCHUpdate a thread
/inboxes/{inbox_id}/threads/{thread_id} - DELETEDelete a thread
/inboxes/{inbox_id}/threads/{thread_id} - POSTAdd labels to a thread
/inboxes/{inbox_id}/threads/{thread_id}/labels - PUTSet a thread's labels
/inboxes/{inbox_id}/threads/{thread_id}/labels - DELETERemove a thread label
/inboxes/{inbox_id}/threads/{thread_id}/labels/{label_id} - GETList a thread's emails
/inboxes/{inbox_id}/threads/{thread_id}/emails - GETGet a thread email
/inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id} - GETList quarantine
/inboxes/{inbox_id}/quarantine - POSTRelease an email
/inboxes/{inbox_id}/quarantine/{email_id}/release - GETGet latest code
/inboxes/{inbox_id}/codes/latest - POSTReply in a thread
/inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}/reply - POSTForward a thread email
/inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}/forward - POSTSend an email from an inbox
/inboxes/{inbox_id}/emails - POSTCreate a draft
/inboxes/{inbox_id}/drafts - GETList drafts
/inboxes/{inbox_id}/drafts - GETRetrieve a draft
/inboxes/{inbox_id}/drafts/{draft_id} - PATCHUpdate a draft
/inboxes/{inbox_id}/drafts/{draft_id} - DELETEDelete a draft
/inboxes/{inbox_id}/drafts/{draft_id} - POSTSend a draft
/inboxes/{inbox_id}/drafts/{draft_id}/send - POSTReject a draft
/inboxes/{inbox_id}/drafts/{draft_id}/reject
Agent
- POSTSign up as an agent
/agent/signup - GETGet the account's claim status
/agent/status - POSTSend the claim link again
/agent/claim-email