LogoLogo
No-code docsResources
  • 🖥️Welcome to the Bird API Docs
  • API Access
    • Access Policies
    • Access Roles
    • API Authorization
    • Common API usage
  • Conversations API
    • API reference
      • Channel configuration
        • Get conversations configuration
        • Update conversations configuration
      • Conversations messaging
        • Create conversation message
        • List conversation messages
        • Get conversation message
        • Update conversation message
        • Delete conversation message
        • Create pre-signed upload
      • Conversations management
        • Create conversation
        • List conversations
        • Get conversation
        • Update conversation
        • Delete conversation
      • Conversation Participants
        • Add participant to conversation
        • List participants
        • Get participant by ID
        • Get participant by identifier key and value
        • Update participant by ID
        • Update participant by identifier key and value
        • Delete participant
        • List participant conversations by ID
        • List participant conversations by identifier key and value
      • Workspace settings
        • Get antispam setting
        • Update antispam setting
        • Create allow/block rule
        • Get allow/block rule
        • List allow/block rules
        • Update allow/block rule
        • Delete allow/block rule
        • Add allow/block rules in bulk
        • Get allow/block bulk upload status
      • Events
  • Collaborations API
    • API reference
      • Agent Management
      • Team Management
      • Feeds
      • Feed item activity
      • Tags
      • Automation Rules
      • Business Hours
      • Capacity Rules
      • Routing Queues
      • Skills
      • SLA Policies
      • Macros
      • Sender Profiles
      • Ticket fields
  • Channels API
    • Supported channels
      • Programmable WhatsApp
        • Sending WhatsApp messages
        • Customer service window
        • Receiving messages
        • Message interactions
        • WhatsApp ISV integration
          • Setting up your customer workspaces
            • API Access
            • Associating your Facebook solution ID and business ID with your Bird CRM Organization
            • Creating a workspace for your customer
            • Buying a number through Bird
            • Subscribing to channel created webhooks
          • WhatsApp channel onboarding
            • Setting up the WhatsApp Embedded flow
            • Install WhatsApp phone number in Bird CRM
            • Subscribe to channel webhooks
      • Programmable SMS
        • Installing an SMS channel
          • US 10DLC API Installation
          • Toll-Free Numbers Verification API
        • Sending SMS messages
        • Receiving messages
        • Twilio Exit API
          • Using Twilio PHP SDK
          • Using Twilio Go SDK
          • Using Twilio Ruby SDK
        • Sinch Exit API
      • Programmable RCS
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Email
        • Sending Emails
        • Receiving messages
        • Message status
        • Message interactions
      • Programmable Line
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Telegram
        • Sending messages
        • Receiving messages
        • Message interactions
    • Message types
      • Text
      • Images
      • Files
      • List
      • Carousel
      • Template
    • Message status and interactions
      • Message Failure Codes
      • Message Failure Sources
        • SMS Platform Extended Error Codes
    • Send batch messages
    • API reference
      • Channel Groups
      • Messaging
      • Channels management
      • Channel connectors
      • Navigators
      • Compliance Keywords Messages
      • Conversions Sharing
      • Events
    • Rate Limit
  • Voice API
    • Installing a Voice channel
    • Voice Calls API
      • Initiate an outbound call
      • List calls from a channel
      • Get a call
      • Update a call
      • Answer a call
      • Ring a call
      • Hangup a call
      • Play a message in a call
      • Say Text-To-Speech (TTS)
      • Gather DTMF from a call
      • Forward a call
      • Record a Call
      • Record a call session
      • Update a call recording
      • List call recordings of a call
      • Get a call recording
      • Get a call insights
      • Get calls log
    • Recordings API
      • List Recordings
      • Get a Recording
      • Delete a Recording
      • List recording storage metrics
    • Transcriptions API
      • Initiate a Transcription
      • List Transcriptions
      • Get a Transcription
      • Delete a Transcription
    • Voice webhooks
    • Flash Calling API
  • Verify API
    • Verify API: Quick Start
  • Contacts API
    • Tracking Contact Events
      • API Reference
        • Get configuration
        • Track events
    • API reference
      • Manage workspace contacts
        • Create a contact
        • Get a contact
        • List contacts
        • Search contact by identifier
        • Update a contact
        • Create or update a contact by identifier
        • Delete a contact
      • Manage contact identifiers
        • Create contact identifier
        • List contact identifiers
        • Delete contact identifier
      • Manage contact attribute definition
        • Create attribute definition
        • Get attribute definition
        • List attribute definitions
      • Manage contact lists
        • Create a list
        • Get a list
        • List lists
        • Update a list
        • Delete a list
        • Add contacts to a list
        • Get contact list memberships
        • List contacts in a list
        • Remove contacts from a list
      • Lookup
        • Network/Country information for a phone number
  • Numbers API
    • API reference
      • Search Available Numbers
      • Buy a Number
      • List your Numbers
      • Get Long Code Number Details
      • Manage Endpoint Subscriptions
        • Cancel Number Subscription
      • Manage Endpoint Compliance Requirements
        • List Workspace compliace Requirements
        • Get Workspace Compliace Requirements
        • Update Workspace Compliace Requirements
      • 10DLC Compliance
        • Brands - Organization
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
        • Brands - workspace
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
          • List brand vettings
        • Campaigns
          • Optional: acting as Reseller
          • Create a campaign
          • List all campaigns
          • Get a campaign
          • Update a campaign
          • Delete a campaign
        • TCR Enums
        • Events
      • Toll-Free Numbers Verification API
      • Long Code Numbers
      • Short Code Numbers
      • Alphanumeric Senders
      • Events
  • Know-Your-Customer (KYC) API
    • List KYC forms
    • Get KYC form
    • Create KYC form entry
    • Update KYC form entry
    • List KYC form entries
    • Get a KYC form entry details
  • Reporting API
    • API reference
      • Channel Metrics
      • Flow Run Metrics
      • Wallet Metrics
      • Campaign Metrics
      • Message Metrics
  • Accounts API
    • API reference
      • Current user
        • Change password
        • Presigned upload
        • Memberships
        • Sessions
        • Configurations
          • Groups
            • Keys
      • IAM policies
      • Organizations
        • Upload media
        • Profile
        • Workspaces
        • Users
        • Access keys
        • Organization roles
        • Organization policies
        • Teams
          • Members
        • Approvals
          • Runs
            • Reviews
        • Configurations
          • Groups
            • Keys
      • Region groups
  • Touchpoints API
    • Supported Projects
      • Whatsapp Approved Message Templates
        • Creating WhatsApp Message templates
          • Text template blocks
          • Blocks Documentation
    • API reference
      • Projects
      • Message Templates
  • Notifications API
    • API Reference
      • Webhook subscriptions
        • Create a webhook subscription
        • List available webhook events
        • Get a webhook subscription
        • List webhook subscriptions
        • Update a webhook subscription
        • Delete a webhook subscription
        • Verifying a webhook subscription
        • Webhook subscription logs
  • Knowledge Base (KB) API
    • API reference
      • Documents
      • Folders
        • Import
      • Search
      • Presigned upload
  • Email API
    • Transmissions
  • Connectivity platform migration guide
    • Channels API and Conversations API
    • Migrating conversations API actions
    • Migrating WhatsApp channels
  • Client SDKs
    • Applications
    • Contact Profiles
      • Signed Identity
    • Push notifications
      • Quick Start
      • Subscribe contacts to push notification campaigns
      • Notification Display Priority
    • Event Tracking
      • Quick Start
      • Track Events
        • App
        • Audiences
        • Conference
        • Ecommerce
        • Hospitality
        • Lists
        • Messaging
        • Payments
        • Subscription
        • Suppressions
        • Survey
        • Web
    • App Inbox
      • Quick Start
      • Usage
      • Subscribe contacts to app inbox campaigns
    • SDK Integration
      • Android SDK
        • Notification Interactions
      • Swift SDK
        • Notification Interactions
      • Web SDK
        • Quick Start
        • Usage
        • API Reference
          • IdentityManager
          • BirdSdkApi
          • BirdTracker
            • Ecommerce
            • Conference
            • Messaging
            • Suppressions
            • Subscription
            • Survey
            • Web
            • Audiences
        • Web Push Notifications
          • Notification Interactions
  • Quickstarts
    • Conversations
    • Send an SMS message
    • Send an Email message
    • Send a WhatsApp message
Powered by GitBook
On this page
  • Step 1: Setup your API Key
  • Step 2: Create an email channel
  • Step 3: Check your workspace ID
  • Step 4: Send a message
  • Step 5: Checking messages
  • 1. UI
  • 2. API
  • 3. Webhook
  • Troubleshooting
  • Unable to verify DNS records

Was this helpful?

  1. Quickstarts

Send an Email message

A walkthrough on setting up an email channel and using it

Last updated 5 months ago

Was this helpful?

By following these instructions, you'll be able to setup an Email channel and use it to send messages through the API.

Step 1: Setup your API Key

In order to send messages through the API, you'll need an API key. Click the bottom left menu and then select User Settings.

Head to Security -> Access Keys -> Add new access key.

Create an access key with the role Application Developer.

Now you have an access key you'll be able to use when sending messages through the API.

Step 2: Create an email channel

In the top left menu, select Manage Channels -> Email.

Click Install Email and fill out the information about your email channel.

If everything worked, in the Health tab you should see a message saying your channel is healthy and ready to be used.

Lastly, take note of your channel ID in the settings tab, you'll need it when performing the API request.

Step 3: Check your workspace ID

The last thing we need to send messages is to know your workspace ID. In the bottom left menu, select User Settings and navigate to Organization -> Workspaces and then select your workspace, now you should be able to take note of your workspace ID.

Step 4: Send a message

Use the command below to perform a request that sends a message. You'll need to fill in your workspace ID, your channel ID, your API key, and your email.

curl -X POST 'https://api.bird.com/workspaces/<your workspace ID>/channels/<your channel ID>/messages' \
-H 'Authorization: AccessKey <your access key>' \
-H 'Content-Type: application/json' \
-d '{
  "receiver": {
    "contacts": [
      {
        "identifierValue": "<your email>"
      }
    ]
  },
  "body": {
    "type": "html",
    "html": {
      "metadata": {
        "subject": "Hello!"
      },
      "html": "<p>Congratulations, you just sent an email with Bird!</p>",
      "text": "Congratulations, you just sent an email with Bird!"
    }
  }
}'
{
  "id": "b0b858d3-75d7-4fe3-a5a3-8d7c8ee8471c",
  "channelId": "7b0eb8a0-606b-59f1-bd90-43cacb048146",
  "sender": {
    "connector": {
      "id": "fdd994a8-31fd-4b24-9c9c-0392f91aaf76",
      "identifierValue": "inbox@example.com"
    }
  },
  "receiver": {
    "contacts": [
      {
        "id": "18220490-9ef7-4a5a-9b9f-7db6903009d2",
        "identifierKey": "emailaddress",
        "identifierValue": "john.doe@bird.com",
        "platformAddress": "john.doe@bird.com"
      }
    ]
  },
  "body": {
    "type": "html",
    "html": {
      "text": "Congratulations, you just sent an email with Bird!",
      "html": "<p>Congratulations, you just sent an email with Bird!</p>",
      "metadata": {
        "subject": "Hello!"
      }
    }
  },
  "meta": {
    "email": {
      "subject": "Hello!"
    }
  },
  "reference": "",
  "parts": [],
  "status": "accepted",
  "reason": "",
  "direction": "outgoing",
  "context": {},
  "lastStatusAt": "2024-12-04T15:57:22.391Z",
  "createdAt": "2024-12-04T15:57:22.391Z",
  "updatedAt": "2024-12-04T15:57:22.391Z",
  "notification": {},
  "batchId": null
}

Step 5: Checking messages

1. UI

In the developer console, you can access Email -> Emails Log.

Alternatively, you can navigate to your channel and switch to the Logs tab.

2. API

3. Webhook

Troubleshooting

Unable to verify DNS records

If your DNS records can't be verified, use the dig tool to check that domains are responding with the expected value, for example:

$ dig scph1023._domainkey.bird.com txt +short @1.1.1.1
"v=DKIM1; k=rsa; h=sha256; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDM2lbd61qfnFm+EfN6nIRJYaDsBC25HF0tTw7im7qdCQ78CMRvVd9/dPmf6kPFkOQ7AHnji0uN26tpmeZ7e0B5ruPmomRAZhPMAo5okLM2ZyGfopy5JOIqwvE20NBC9S8PPIdp2Av5PvYy92ga+DY1HfWEyB6T2wbXuFyOKnuX/QIDAQAB"

Keep in mind it may take a few minutes for new DNS values to be propagated.

Another possibility is that your tracking domain is in use by another organization. To check if that's the case, make sure the health check for "Tracking Domain Exists" is OK.

After creating your channel, you'll be presented with a few DNS records that need to be registered with your DNS provider. Once the DNS records are in place, click Verify domain at the bottom. You may need to retry this a few times due to DNS propagation times. If you're having difficulty with this step, check out the section.

You can verify the in the following ways:

To retrieve message details through the API, refer to the . You can find more information on the available endpoints, request formats, and required parameters.

In the Developer console, head to Preferences -> Webhooks and create a webhook subscription to the channels service with the event email.outbound. For additional information, refer to the .

message status
Notifications API
Troubleshooting
Messaging API Documentation
User Settings menu
Access key management
Creating a new access key
Channels management
Email channel installation
Email DNS records
Health tab
Channel ID
Workspace ID
Email logs
Channel logs
Creating webhook
Tracking domain health check