🖥️Welcome to the Bird API Docs
API Access
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
  Tasks
  Tags
  Automation Rules
  Business Hours
  Capacity Rules
  Routing Queues
  Skills
  SLA Policies
  Macros
  Sender Profiles
  Ticket fields
Channels API
Voice API
Verify API
Contacts API
- Tracking Contact Events
  API Reference
  Get configuration
  Track events
- API reference
  Manage workspace contacts
  Create a contact
  Get a contact
  List contacts
  Update a contact
  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
  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
  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
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
Connectivity platform migration guide
Client SDKs
Quickstarts