Documentation

Sign in Get started

Get started

Install and setup

Email

Overview
Send an email message.
Send a batch of email messages in one call.
Get a message
List messages
Cancel a scheduled message
Get stored message content
List recipients of a message
Manage email sending domains
Manage dedicated IPs
Manage IP pools
Manage the email suppression list
Email deliverability tools
Manage inbound (forward) email addresses
Read received (inbound) emails
Read aggregate email statistics

SMS

Overview
Send an SMS message to one recipient.
Get an SMS message
List SMS messages
Browse the workspace's SMS templates

WhatsApp

Overview
Send a WhatsApp template message to one recipient.
Get a WhatsApp message
List WhatsApp messages
List events for a WhatsApp message
Browse WhatsApp templates

Contacts

Overview

Audiences

Overview
Create an audience.
Get an audience
List audiences
Update an audience's name or description.
Delete an audience
Add contacts to a static audience.
List an audience's contacts
Remove a contact from an audience
Remove contacts from a static audience.

Contact properties

Overview

Webhooks

Overview

Verify

Overview

Docs

Overview

Request logs

Overview

Auth

Overview
Authenticate with Bird through your browser (OAuth)
Revoke the OAuth grant (if any) and remove the stored credentials file
Show current authentication state and validate the token against the API
Start a passwordless Bird signup and email a six-digit code.
Confirm the emailed six-digit code and sign in.
Create the first organization and workspace and mint your credential.

Billing

Overview

Support tickets

Overview

Members

Overview

Invitations

Overview

Organization

Overview

Workspace

Overview

Config

Overview

CLI

Print the CLI version
Update the bird CLI to the latest release
Print the full command tree as JSON
Serve Bird as MCP tools over stdio
Show the signed-in user (id, email, name)

bird version

Usage

Code example

bird version

Description

Print the CLI version

Usage
Description