Bird API
The current Bird platform API: one REST API for email, SMS, WhatsApp, verification, lookup and Realtime, plus workspaces, organizations, teams, sending domains, dedicated IPs, suppressions, contacts and audiences. 277 operations over 216 paths, described by a first-party OpenAPI 3.1 document Bird publishes at https://bird.com/openapi.json and generates its SDKs from. Bearer API keys prefixed bk_{region}_ or OAuth 2.0 access tokens from platform.bird.com; opt-in Idempotency-Key on every mutating request; IETF RateLimit response headers; a stable, documented error-code catalog; and Standard Webhooks event delivery.
This API exposes 282 operations across 218 paths, organized into 37 resource areas, and defines 3756 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 3 base URLs: https://{region}.platform.bird.com, https://platform.bird.com, http://localhost:8080.
282 operations
218 paths
3756 schemas
24 DELETE179 GET18 PATCH59 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Bird API declares
4 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
An API key is passed in the cookie as bird_session (CookieAuth).
An API key is passed in the header as X-Realtime-Key (RealtimeKey).
An API key is passed in the header as X-Realtime-Secret (RealtimeSecret).
By default, every request must be authenticated.
BearerAuth— Pass the API key as a bearer token in the Authorization header. Keys use the format bk{region}. The prefix identifies the region and selects the API endpoint.…CookieAuth— Session cookie set after signing in to the Bird dashboard. The cookie value is an opaque session token; no session data is stored in the cookie itself.RealtimeKey— The Realtime app key. Together with X-Realtime-Secret, it authenticates a request to the Realtime API in addition to the workspace credential. Both values come…RealtimeSecret— The Realtime app secret paired with X-Realtime-Key. The API returns the secret only when the key is created and does not store it. Create a new key and revoke…
Paths & Operations 282
Across 218 paths, the API surfaces 282 operations — 24 DELETE, 179 GET, 18 PATCH, 59 POST, 2 PUT. They span 37 resource areas, including docs, workspaces, realtime-apps, realtime-events, email-messages, email-broadcasts, email-contacts, preferences, and 29 more. Each is listed below with its method, path, parameters, and response codes.
docs 2
Search our developer documentation.
GET
/v1/docs/search
Get documentation search results
GET
/v1/docs/pages
Get a documentation page
workspaces 1
Workspace management.
GET
/v1/workspace
Get the current workspace
realtime-apps 9
Realtime app management.
GET
/v1/realtime/regions
List Realtime regions
POST
/v1/realtime/apps
Create a Realtime app
GET
/v1/realtime/apps
List Realtime apps
GET
/v1/realtime/apps/{realtime_app_id}
Get a Realtime app
PATCH
/v1/realtime/apps/{realtime_app_id}
Update a Realtime app
DELETE
/v1/realtime/apps/{realtime_app_id}
Delete a Realtime app
GET
/v1/realtime/apps/{realtime_app_id}/keys
List a Realtime app's keys
POST
/v1/realtime/apps/{realtime_app_id}/keys
Create a Realtime app key
POST
/v1/realtime/apps/{realtime_app_id}/keys/{realtime_app_key_id}/revoke
Revoke a Realtime app key
realtime-events 7
Publish events to a Realtime app's channels from your server (the data plane). Sending to several channels at once broadcasts to all of them.
POST
/v1/realtime/apps/{realtime_app_id}/events
Publish a Realtime event
POST
/v1/realtime/apps/{realtime_app_id}/batch-events
Publish a batch of Realtime events
GET
/v1/realtime/apps/{realtime_app_id}/channels
List Realtime channels
GET
/v1/realtime/apps/{realtime_app_id}/channels/{channel_name}
Get a Realtime channel
GET
/v1/realtime/apps/{realtime_app_id}/channels/{channel_name}/members
List members on a presence channel
POST
/v1/realtime/apps/{realtime_app_id}/members/{member_id}/disconnect
Disconnect a member
POST
/v1/realtime/apps/{realtime_app_id}/members/{member_id}/events
Send an event to a member
email-messages 9
Send emails to recipients you address explicitly in to, cc, and bcc. Use this for transactional sends (receipts, password resets, alerts) and for marketing sends where you already…
POST
/v1/email/messages
Create an email message
GET
/v1/email/messages
List messages
POST
/v1/email/batches
Create a batch of email messages
GET
/v1/email/messages/{message_id}
Get a message
POST
/v1/email/messages/{message_id}/cancel
Cancel a scheduled message
GET
/v1/email/messages/{message_id}/recipients
List recipients of a message
GET
/v1/email/messages/{message_id}/events
List events for a message
GET
/v1/email/messages/{message_id}/content
Get stored message content
GET
/v1/email/messages/{message_id}/attachments/{attachment_id}
Get a message attachment
email-broadcasts 14
Send one email to a stored audience. Create a broadcast as a draft, then send it immediately or schedule it for later; scheduled and in-progress broadcasts can be canceled. The au…
POST
/v1/email/broadcasts
Create a broadcast
GET
/v1/email/broadcasts
List broadcasts
GET
/v1/email/broadcasts/export
Export broadcasts as CSV
GET
/v1/email/broadcasts/{broadcast_id}
Get a broadcast
PATCH
/v1/email/broadcasts/{broadcast_id}
Update a broadcast
DELETE
/v1/email/broadcasts/{broadcast_id}
Delete a broadcast
GET
/v1/email/broadcasts/{broadcast_id}/counts
Get a broadcast's audience counts
GET
/v1/email/broadcasts/{broadcast_id}/send-quota
Get how much of a broadcast the send allowance covers
GET
/v1/email/broadcasts/{broadcast_id}/recipients
List recipients of a broadcast
GET
/v1/email/broadcasts/{broadcast_id}/recipients/export
Export a broadcast's recipients as CSV
GET
/v1/email/broadcasts/{broadcast_id}/events
List events for a broadcast
GET
/v1/email/broadcasts/{broadcast_id}/clicked-links
List a broadcast's clicked links
POST
/v1/email/broadcasts/{broadcast_id}/send
Send a broadcast
POST
/v1/email/broadcasts/{broadcast_id}/cancel
Cancel a broadcast
email-contacts 12
Contacts are the people you send broadcasts to. Each contact is unique by email address within a workspace and carries optional name fields and custom properties for personalizati…
POST
/v1/contacts
Create a contact
GET
/v1/contacts
List contacts
POST
/v1/contacts/batch
Create or update contacts in bulk
GET
/v1/contacts/{contact_id}
Get a contact
PATCH
/v1/contacts/{contact_id}
Update a contact
DELETE
/v1/contacts/{contact_id}
Delete a contact
POST
/v1/contact-properties
Create a contact property
GET
/v1/contact-properties
List contact properties
GET
/v1/contact-properties/{property_id}
Get a contact property
PATCH
/v1/contact-properties/{property_id}
Update a contact property
POST
/v1/contact-properties/{property_id}/archive
Archive a contact property
POST
/v1/contact-properties/{property_id}/unarchive
Unarchive a contact property
preferences 5
Stated messaging preferences (consent grants and opt-outs) recorded per handle across email, SMS, and WhatsApp, with causally ordered writes.
GET
/v1/contacts/{contact_id}/preferences
List a contact's preferences
GET
/v1/preferences
List preferences
POST
/v1/preferences
Record a preference
GET
/v1/preferences/{preference_id}
Get a preference
DELETE
/v1/preferences/{preference_id}
Delete a preference
email-audiences 9
Audiences are the recipient lists broadcasts are sent to. An audience holds a set of contacts that you manage through the API. The contacts in the audience at send time become the…
POST
/v1/audiences
Create an audience
GET
/v1/audiences
List audiences
GET
/v1/audiences/{audience_id}
Get an audience
PATCH
/v1/audiences/{audience_id}
Update an audience
DELETE
/v1/audiences/{audience_id}
Delete an audience
GET
/v1/audiences/{audience_id}/contacts
List an audience's contacts
POST
/v1/audiences/{audience_id}/contacts
Assign contacts to an audience
POST
/v1/audiences/{audience_id}/contacts/remove
Unassign contacts from an audience
DELETE
/v1/audiences/{audience_id}/contacts/{contact_id}
Unassign a contact from an audience
sms-messages 5
Send SMS messages to recipients you address by phone number, and read their delivery status and lifecycle events. Each message is one recipient and one body; set category to contr…
POST
/v1/sms/messages
Create an SMS message
GET
/v1/sms/messages
List SMS messages
POST
/v1/sms/batches
Create a batch of SMS messages
GET
/v1/sms/messages/{message_id}
Get an SMS message
GET
/v1/sms/messages/{message_id}/events
List events for an SMS message
sms-templates 6
Create and publish multilingual workspace SMS templates and browse built-in templates. Published workspace versions preserve their language content; built-in versions reflect the…
GET
/v1/sms/templates
List SMS templates
GET
/v1/sms/templates/{template_ref}
Get an SMS template
GET
/v1/sms/templates/{template_ref}/versions
List an SMS template's versions
GET
/v1/sms/templates/{template_ref}/versions/{version_id}
Get an SMS template version
GET
/v1/sms/templates/{template_ref}/versions/{version_id}/languages
List an SMS template version's languages
GET
/v1/sms/templates/{template_ref}/versions/{version_id}/languages/{language}
Get an SMS template version's language
sms-suppressions 4
Sender and subscriber pairs that block SMS delivery.
GET
/v1/sms/suppressions
List SMS suppressions
POST
/v1/sms/suppressions
Create an SMS suppression
GET
/v1/sms/suppressions/{suppression_id}
Get an SMS suppression
DELETE
/v1/sms/suppressions/{suppression_id}
Delete an SMS suppression
sms-keyword-rules 5
Manage the response when someone sends a keyword to one of your numbers. Each supported country starts with opt-out, opt-in, and help keywords. Create a rule to replace a default…
GET
/v1/sms/keyword-rules
List SMS keyword rules
POST
/v1/sms/keyword-rules
Create an SMS keyword rule
GET
/v1/sms/keyword-rules/{id}
Get an SMS keyword rule
PATCH
/v1/sms/keyword-rules/{id}
Update an SMS keyword rule
DELETE
/v1/sms/keyword-rules/{id}
Delete an SMS keyword rule
sms-stats 16
SMS analytics, including daily and hourly lifecycle counts, dimension breakdowns, and a KPI summary.
GET
/v1/sms/stats/summary
Get aggregate outbound SMS statistics
GET
/v1/sms/stats/daily
Get daily outbound SMS statistics
GET
/v1/sms/stats/hourly
Get hourly outbound SMS statistics
GET
/v1/sms/stats/originators
Get outbound SMS statistics by originator
GET
/v1/sms/stats/countries
Get outbound SMS statistics by country
GET
/v1/sms/stats/categories
Get outbound SMS statistics by category
GET
/v1/sms/stats/error-codes
Get outbound SMS statistics by error code
GET
/v1/sms/stats/carriers
Get outbound SMS statistics by carrier
GET
/v1/sms/stats/tags
Get outbound SMS statistics by tag
GET
/v1/sms/stats/statuses
Get outbound SMS statistics by status
GET
/v1/sms/stats/inbound/summary
Get aggregate inbound SMS statistics
GET
/v1/sms/stats/inbound/daily
Get daily inbound SMS statistics
GET
/v1/sms/stats/inbound/hourly
Get hourly inbound SMS statistics
GET
/v1/sms/stats/inbound/countries
Get inbound SMS statistics by country
GET
/v1/sms/stats/inbound/operators
Get inbound SMS statistics by operator
GET
/v1/sms/stats/inbound/numbers
Get inbound SMS statistics by number
lookup 4
Inspect a recipient before sending. Phone-number lookups return carrier, portability, number type, reachability, roaming, SIM-change, and fraud-risk data when requested. Email loo…
POST
/v1/lookup/phone-number
Create a phone number lookup
GET
/v1/lookup/phone-number/{number}
Get a phone number lookup by URL
POST
/v1/lookup/email
Create an email address lookup
GET
/v1/lookup/email/{address}
Get an email address lookup by URL
verify-verifications 3
Send a one-time passcode to a recipient and check the code they enter. Create a verification to send a passcode over email or SMS, then submit the recipient's code to verify it.
POST
/v1/verify/verifications
Create a verification
POST
/v1/verify/verifications/check
Create a verification passcode check
POST
/v1/verify/verifications/next-channel
Create the next verification channel attempt
whatsapp-messages 9
Send WhatsApp messages, whether a template, free-form content, or interactive content the recipient can tap, and read the messages your workspace sent and received, including thei…
GET
/v1/whatsapp/messages
List WhatsApp messages
POST
/v1/whatsapp/messages
Send a WhatsApp message
GET
/v1/whatsapp/messages/{message_id}
Get a WhatsApp message
POST
/v1/whatsapp/messages/{message_id}/read
Mark a WhatsApp message as read
GET
/v1/whatsapp/messages/{message_id}/events
List events for a WhatsApp message
GET
/v1/whatsapp/messages/{message_id}/media/{media_id}
Get a WhatsApp message's media
PUT
/v1/whatsapp/messages/{message_id}/reaction
React to a WhatsApp message
DELETE
/v1/whatsapp/messages/{message_id}/reaction
Remove your reaction from a WhatsApp message
GET
/v1/whatsapp/messages/{message_id}/reaction-events
List reaction events for a WhatsApp message
whatsapp-templates 6
Browse the WhatsApp message templates available to your workspace, approved by Meta and ready to send.
GET
/v1/whatsapp/templates
List available message templates
GET
/v1/whatsapp/templates/{template_ref}
Get a message template
GET
/v1/whatsapp/templates/{template_ref}/versions
List a template's versions
GET
/v1/whatsapp/templates/{template_ref}/versions/{version_id}
Get a template version
GET
/v1/whatsapp/templates/{template_ref}/versions/{version_id}/languages
List a version's languages
GET
/v1/whatsapp/templates/{template_ref}/versions/{version_id}/languages/{language}
Get a version's language
whatsapp-stats 13
WhatsApp analytics, including daily and hourly delivery statistics and a KPI summary.
GET
/v1/whatsapp/stats/summary
Get aggregate outbound WhatsApp statistics
GET
/v1/whatsapp/stats/daily
Get daily outbound WhatsApp statistics
GET
/v1/whatsapp/stats/hourly
Get hourly outbound WhatsApp statistics
GET
/v1/whatsapp/stats/error-codes
Get outbound WhatsApp statistics by error code
GET
/v1/whatsapp/stats/templates
Get outbound WhatsApp statistics by template
GET
/v1/whatsapp/stats/template-categories
Get outbound WhatsApp statistics by template category
GET
/v1/whatsapp/stats/tags
Get outbound WhatsApp statistics by tag
GET
/v1/whatsapp/stats/phone-numbers
Get outbound WhatsApp statistics by phone number
GET
/v1/whatsapp/stats/countries
Get outbound WhatsApp statistics by country
GET
/v1/whatsapp/stats/inbound/summary
Get aggregate inbound WhatsApp statistics
GET
/v1/whatsapp/stats/inbound/daily
Get daily inbound WhatsApp statistics
GET
/v1/whatsapp/stats/inbound/hourly
Get hourly inbound WhatsApp statistics
GET
/v1/whatsapp/stats/inbound/phone-numbers
Get inbound WhatsApp statistics by phone number
whatsapp-numbers 4
Connect phone numbers from Meta's embedded signup flow and check their WhatsApp setup status.
GET
/v1/whatsapp/numbers
List WhatsApp numbers
GET
/v1/whatsapp/numbers/{number_id}
Get a WhatsApp number
GET
/v1/whatsapp/numbers/{number_id}/events
List WhatsApp number events
GET
/v1/whatsapp/numbers/{number_id}/profile
Get a WhatsApp number's business profile
whatsapp-business-accounts 2
Read the WhatsApp Business Accounts your workspace has connected, so a template can be created on the account you choose.
GET
/v1/whatsapp/business-accounts
List WhatsApp Business Accounts
GET
/v1/whatsapp/business-accounts/{business_account_ref}
Get a WhatsApp Business Account
whatsapp-keyword-rules 5
What happens when someone replies STOP or START to a WhatsApp message: the keywords Bird ships, the keywords you add, and the replies you send back.
GET
/v1/whatsapp/keyword-rules
List WhatsApp keyword rules
POST
/v1/whatsapp/keyword-rules
Create a WhatsApp keyword rule
GET
/v1/whatsapp/keyword-rules/{id}
Get a WhatsApp keyword rule
PATCH
/v1/whatsapp/keyword-rules/{id}
Update a WhatsApp keyword rule
DELETE
/v1/whatsapp/keyword-rules/{id}
Delete a WhatsApp keyword rule
email-inbox-insights 9
Inbox placement, seed tests, and sending reputation for the workspace's own sending domains, measured from a panel of real mailboxes. Rates here are percentages carrying a percent…
GET
/v1/email/inbox-insights/placement
Get inbox placement for a sending domain
GET
/v1/email/inbox-insights/authentication
Get email authentication standing for a sending domain
GET
/v1/email/inbox-insights/complaints
Get the Google-reported spam rate for a sending domain
GET
/v1/email/inbox-insights/spam-traps
Get spam-trap hits for a sending domain
GET
/v1/email/inbox-insights/blocklists
Check whether a sending domain's infrastructure is blocklisted
GET
/v1/email/inbox-insights/benchmarks/industry
Get the industry placement benchmark for a sending domain
GET
/v1/email/inbox-insights/domains
List sending domains and their Inbox Insights status
PATCH
/v1/email/inbox-insights/domains/{sending_domain}
Switch Inbox Insights on or off for a sending domain
POST
/v1/email/inbox-insights/domain-monitoring
Switch Inbox Insights on for the workspace's main sending domain
email-stats 17
Email analytics, including daily and hourly delivery statistics, tag breakdowns, and a KPI summary.
GET
/v1/email/stats/daily
Get daily sending statistics
GET
/v1/email/stats/hourly
Get hourly sending statistics
GET
/v1/email/stats/tags
Get statistics by tag
GET
/v1/email/stats/summary
Get aggregate email statistics
GET
/v1/email/stats/sending-ips
Get statistics by sending IP
GET
/v1/email/stats/sending-domains
Get statistics by sending domain
GET
/v1/email/stats/categories
Get statistics by category
GET
/v1/email/stats/mailbox-providers
Get statistics by mailbox provider
GET
/v1/email/stats/mailbox-provider-regions
Get statistics by mailbox provider region
GET
/v1/email/stats/recipient-domains
Get statistics by recipient domain
GET
/v1/email/stats/templates
Get statistics by template
GET
/v1/email/stats/locations
Get engagement by location
GET
/v1/email/stats/clients
Get engagement by email client
GET
/v1/email/stats/bounce-codes
Get bounces by SMTP error code
GET
/v1/email/stats/complaint-types
Get complaints by type
GET
/v1/email/stats/broadcasts
Get statistics by broadcast
GET
/v1/email/health
Get sending health and deliverability limits
domains 9
Sending domain management and DNS verification.
POST
/v1/email/domains
Create a sending domain
GET
/v1/email/domains
List sending domains
PATCH
/v1/email/domains/{domain_id}
Update a sending domain
GET
/v1/email/domains/{domain_id}
Get a sending domain
DELETE
/v1/email/domains/{domain_id}
Delete a sending domain
GET
/v1/email/domains/{domain_id}/events
List domain events
POST
/v1/email/domains/{domain_id}/verify
Verify a domain
POST
/v1/email/domains/{domain_id}/tracking/release
Release link tracking configuration
POST
/v1/email/domains/{domain_id}/dns-records/share
Share a domain's DNS records by email
email-suppressions 4
Email suppression list management.
GET
/v1/email/suppressions
List email suppressions
POST
/v1/email/suppressions
Create an email suppression
GET
/v1/email/suppressions/{suppression_id}
Get an email suppression
DELETE
/v1/email/suppressions/{suppression_id}
Delete an email suppression
email-competitive 10
Watch competitor brands and see how their email compares with yours. Figures about a competitor are estimates from an email panel, which observes a sample of real inboxes; figures…
GET
/v1/email/competitive/watchlist
Get the competitor watchlist with its latest figures
GET
/v1/email/competitive/watchlist/notable
Get the notable campaigns across watched brands
POST
/v1/email/competitive/watchlist/brands
Add a competitor brand to the watchlist
GET
/v1/email/competitive/watchlist/brands/{watchlist_brand_id}
Get a watched brand's figures
DELETE
/v1/email/competitive/watchlist/brands/{watchlist_brand_id}
Remove a competitor brand from the watchlist
GET
/v1/email/competitive/watchlist/brands/{watchlist_brand_id}/campaigns
Get the campaigns a watched brand sent
GET
/v1/email/competitive/watchlist/brands/{watchlist_brand_id}/campaigns/{campaign_id}
Get one campaign a watched brand sent
GET
/v1/email/competitive/watchlist/brands/{watchlist_brand_id}/send-time
Get when a watched brand sends
GET
/v1/email/competitive/brands/search
Search brands to add to the watchlist
GET
/v1/email/competitive/volume-series
Get send volume over time for watched brands
email-templates 18
Reusable email templates and their versions, with stored subject, HTML, and plain-text content you manage and reference when sending.
POST
/v1/email/templates
Create an email template
GET
/v1/email/templates
List email templates
GET
/v1/email/templates/{template_ref}
Get an email template
PATCH
/v1/email/templates/{template_ref}
Update an email template
DELETE
/v1/email/templates/{template_ref}
Delete an email template
POST
/v1/email/templates/{template_ref}/duplicate
Duplicate an email template
POST
/v1/email/templates/{template_ref}/preview
Get an email template preview
GET
/v1/email/templates/{template_ref}/versions
List email template versions
GET
/v1/email/templates/{template_ref}/broadcasts
List the broadcasts blocking a template delete
GET
/v1/email/templates/{template_ref}/versions/{version_id}
Get an email template version
DELETE
/v1/email/templates/{template_ref}/versions/{version_id}
Delete an email template draft
GET
/v1/email/templates/{template_ref}/versions/{version_id}/languages
List a version's languages
GET
/v1/email/templates/{template_ref}/versions/{version_id}/languages/{language}
Get one language of a version
PUT
/v1/email/templates/{template_ref}/versions/{version_id}/languages/{language}
Upsert one language of a draft
PATCH
/v1/email/templates/{template_ref}/versions/{version_id}/languages/{language}
Update one language of a draft
DELETE
/v1/email/templates/{template_ref}/versions/{version_id}/languages/{language}
Delete one language from a draft
POST
/v1/email/templates/{template_ref}/versions/{version_id}/rollback
Roll back an email template
POST
/v1/email/templates/{template_ref}/versions/{version_id}/submit
Submit an email template version
email-inbound-addresses 5
Addresses generated for receiving mail. Forward a mailbox to an inbound address to parse each message into a received email.
GET
/v1/email/inbound-addresses
List inbound addresses
POST
/v1/email/inbound-addresses
Create an inbound address
GET
/v1/email/inbound-addresses/{inbound_address_id}
Get an inbound address
PATCH
/v1/email/inbound-addresses/{inbound_address_id}
Update an inbound address
DELETE
/v1/email/inbound-addresses/{inbound_address_id}
Delete an inbound address
email-inbound-messages 6
Emails received on your behalf, including each parsed message, its body, raw MIME content, and attachments.
GET
/v1/email/inbound-messages
List received emails
GET
/v1/email/inbound-messages/{inbound_message_id}
Get a received email
GET
/v1/email/inbound-messages/{inbound_message_id}/body
Get a received email's body
GET
/v1/email/inbound-messages/{inbound_message_id}/raw
Get a received email's raw content
GET
/v1/email/inbound-messages/{inbound_message_id}/attachments
List a received email's attachments
GET
/v1/email/inbound-messages/{inbound_message_id}/attachments/{attachment_id}
Get a received email's attachment
email-mailboxes 11
Durable mailbox identities for agents. A mailbox owns an address, applies receive policy through allow/block rules, and remembers conversations for its retention tier.
GET
/v1/email/mailboxes
List mailboxes
POST
/v1/email/mailboxes
Create a mailbox
GET
/v1/email/mailboxes/{mailbox_id}
Get a mailbox
PATCH
/v1/email/mailboxes/{mailbox_id}
Update a mailbox
DELETE
/v1/email/mailboxes/{mailbox_id}
Delete a mailbox
POST
/v1/email/mailboxes/{mailbox_id}/restore
Restore a deleted mailbox
GET
/v1/email/mailboxes/{mailbox_id}/stats
Get mailbox email statistics
POST
/v1/email/mailboxes/{mailbox_id}/resume
Resume a suspended mailbox
GET
/v1/email/mailboxes/{mailbox_id}/receive-rules
List receive rules
POST
/v1/email/mailboxes/{mailbox_id}/receive-rules
Create a receive rule
DELETE
/v1/email/mailboxes/{mailbox_id}/receive-rules/{rule_id}
Delete a receive rule
email-inbound-routes 5
Routing rules that direct inbound mail on your domains into mailboxes, or drop it, in priority order.
GET
/v1/email/inbound-routes
List inbound routes
POST
/v1/email/inbound-routes
Create an inbound route
GET
/v1/email/inbound-routes/{route_id}
Get an inbound route
PATCH
/v1/email/inbound-routes/{route_id}
Update an inbound route
DELETE
/v1/email/inbound-routes/{route_id}
Delete an inbound route
email-threads 16
Conversations in a mailbox. Threads group related inbound and outbound messages and carry read state, labels, and participants.
GET
/v1/email/threads
List threads
GET
/v1/email/threads/{thread_id}
Get a thread
PATCH
/v1/email/threads/{thread_id}
Update a thread
DELETE
/v1/email/threads/{thread_id}
Delete a thread
GET
/v1/email/threads/{thread_id}/messages
List messages in a thread
GET
/v1/email/threads/{thread_id}/messages/{message_id}
Get a message in a thread
PATCH
/v1/email/threads/{thread_id}/messages/{message_id}
Update a message in a thread
DELETE
/v1/email/threads/{thread_id}/messages/{message_id}
Delete a message in a thread
GET
/v1/email/threads/{thread_id}/messages/{message_id}/body
Get a thread message's original body
GET
/v1/email/threads/{thread_id}/messages/{message_id}/raw
Get a thread message's raw content
GET
/v1/email/threads/{thread_id}/messages/{message_id}/attachments
List a thread message's attachments
GET
/v1/email/threads/{thread_id}/messages/{message_id}/attachments/{attachment_id}
Get a thread message's attachment
POST
/v1/email/threads/{thread_id}/messages/{message_id}/reply
Reply to a thread message
GET
/v1/email/mailboxes/{mailbox_id}/messages
List a mailbox's messages
POST
/v1/email/mailboxes/{mailbox_id}/messages
Create a message from a mailbox
GET
/v1/email/mailboxes/{mailbox_id}/labels
List a mailbox's labels
email-smtp-configs 3
Default IP pool, category, tags, and open and click tracking settings for messages submitted over SMTP with a given API key.
GET
/v1/email/smtp/configs
List SMTP configs
GET
/v1/email/smtp/configs/{api_key_id}
Get an SMTP config
PATCH
/v1/email/smtp/configs/{api_key_id}
Update the SMTP config for an API key
webhooks 9
Webhook endpoint management.
POST
/v1/webhooks
Create a webhook endpoint
GET
/v1/webhooks
List webhook endpoints
GET
/v1/webhooks/{webhook_id}
Get a webhook endpoint
PATCH
/v1/webhooks/{webhook_id}
Update a webhook endpoint
DELETE
/v1/webhooks/{webhook_id}
Delete a webhook endpoint
POST
/v1/webhooks/{webhook_id}/rotate-secret
Rotate webhook signing secret
POST
/v1/webhooks/{webhook_id}/test
Test a webhook with a sample event
POST
/v1/webhooks/{webhook_id}/replay
Replay failed deliveries
GET
/v1/webhooks/{webhook_id}/attempts
List delivery attempts
numbers 8
Phone number catalog and purchasing.
GET
/v1/numbers
List your allocated numbers
GET
/v1/numbers/available
List available phone numbers
GET
/v1/numbers/available/{number}
Get an available phone number
POST
/v1/numbers/orders
Create a number order
GET
/v1/numbers/orders
List your number orders
GET
/v1/numbers/orders/{order_id}
Get a number order
GET
/v1/numbers/{number_id}
Get an allocated number
DELETE
/v1/numbers/{number_id}
Release a dedicated number
voice-calls 2
Call records (CDR) for the workspace, in flight and completed.
GET
/v1/voice/calls
List calls
GET
/v1/voice/calls/{call_id}
Get a call
Schemas 3756
The contract defines 3756 schemas that model the data the API accepts and returns. The most detailed are TFNVerificationBase (41 properties), EmailMessage (37 properties), EmailBroadcast (35 properties), AdminPlatformUser (33 properties). Each schema is shown below with its type and property counts.
WebhookEvent
Webhook delivery body. type identifies the event variant, timestamp is when the event occurred, and data contains the event-specific payload. See the [webhooks…
RootResponse
object
2 properties
2 required
ErrorDetail
object
2 properties
2 required
NextAction
object
5 properties
2 required
ErrorBody
object
11 properties
6 required
Error
object
1 property
1 required
HealthResponse
object
1 property
1 required
SignupRequest
object
4 properties
2 required
SignupResult
object
1 property
LoginRequest
object
2 properties
2 required
UserID
string
MFAFactorID
string
MFAFactorSummary
object
3 properties
2 required
LoginResponse
object
Returned on login. On success, a session cookie is set via Set-Cookie. When mfarequired or emailotprequired is true, no session is created yet: the client must…
7 properties
MessageResponse
object
1 property
1 required
VerifyEmailOtpRequest
object
2 properties
2 required
EmailVerificationResult
object
2 properties
2 required
ResendVerificationRequest
object
1 property
1 required
ForgotPasswordRequest
object
1 property
1 required
ResetPasswordTokenStatus
object
1 property
1 required
ResetPasswordRequest
object
2 properties
2 required
MagicLinkRequest
object
1 property
1 required
MagicLinkTokenStatus
object
1 property
MagicLinkVerifyRequest
object
1 property
1 required
MagicLinkVerifyCodeRequest
object
2 properties
2 required
TenantName
string
Must include at least one letter or number.
Region
string
Deployment region identifier.
OnboardingRequest
object
4 properties
3 required
OrganizationID
string
OrganizationSummary
object
2 properties
2 required
WorkspaceID
string
WorkspaceSummary
object
2 properties
2 required
OnboardingResponse
object
6 properties
5 required
AuthUser
object
12 properties
3 required
AuthUserUpdate
object
1 property
AccountClosureOrgSummary
object
3 properties
3 required
AccountClosureRequestResult
object
4 properties
4 required
ClosureCancelToken
string
Opaque token from the closure-scheduled email, used to cancel the closure without an authenticated session.
AccountClosureCancelRequest
object
1 property
ChangePasswordRequest
object
2 properties
1 required
Timezone
string
IANA timezone identifier, such as America/NewYork, Europe/Amsterdam, or UTC.
AuthUserPreferences
object
2 properties
1 required
AuthUserPreferencesUpdate
object
2 properties
DashboardPinnedItem
string
Product or platform tool available as a personal sidebar shortcut.
DashboardPinnedItems
array
Ordered product and platform-tool keys pinned in this workspace's sidebar. An empty list hides all optional pins.
DashboardHomeWidget
string
Existing product metric section available on personal Home.
DashboardHomeWidgets
array
Ordered metric-section keys shown on Home in this workspace. An empty list shows no metric sections.
DashboardIntroductionVersion
string
Dashboard introduction release completed or dismissed by the caller, across all workspaces.
DashboardPreferences
object
3 properties
3 required
DashboardPreferencesUpdate
object
3 properties
SortOrder
string
Sort direction, ascending or descending.
AuthUserWorkspaceOrganization
object
4 properties
3 required
AuthUserWorkspace
object
4 properties
3 required
_ListEnvelope
object
3 properties
3 required
_ListEnvelopeWithTotal
AuthUserWorkspaceList
AuthUserOrganization
object
4 properties
4 required
AuthUserOrganizationList
NotifyChannel
string
Product channel associated with a dashboard availability notification request.
ChannelNotification
object
2 properties
2 required
ChannelNotificationList
object
1 property
1 required
ChannelNotificationCreate
object
1 property
1 required
InvitationPreview
object
Details about a pending invitation, identified by the invitation token.
4 properties
4 required
AcceptInvitationAndRegisterRequest
object
3 properties
3 required
InvitationRegistrationResult
object
Returned after a successful invitation acceptance with new account registration.
1 property
1 required
InvitationID
string
AuthUserInvitation
object
5 properties
5 required
AuthUserInvitationList
object
1 property
1 required
OrgRoleEnum.gen
string
WorkspaceRoleEnum.gen
string
OrganizationInvitationWorkspaceRole
object
2 properties
2 required
OrganizationInvitation
object
9 properties
9 required
OAuthGrantSubject
string
What the access belongs to once you approve. - user: it acts as you, and it stops working when your own access does. - serviceaccount: it belongs to the worksp…
OAuthScopeGrant
object
A permission scope paired with the access level it is granted at.
2 properties
2 required
OAuthConsentTarget
object
One organization or workspace the user can grant the application access to, together with the subset of the requested scopes the user is actually able to deleg…
7 properties
5 required
OAuthConsentView
object
Data for rendering the consent screen for a pending authorization request. Includes the requesting application, creation time, requested scopes, and the organi…
8 properties
8 required
OAuthConsentRequest
object
The user's decision for a pending authorization request. To approve, set approve to true and choose a target: provide workspaceid for a workspace grant, or org…
4 properties
1 required
OAuthConsentResponse
object
The outcome of submitting a consent decision.
3 properties
2 required
OAuthDeviceLookupResponse
object
The authorization request resolved from a device user code.
1 property
1 required
OAuthGrantID
string
OAuthGrant
object
A connected CLI or MCP application session: an active grant of access the user approved, including its target, the scopes it holds, and when it was last used.
9 properties
7 required
OAuthGrantList
object
The authenticated user's connected CLI and MCP application sessions.
1 property
1 required
OAuthClientID
string
AdminOAuthClientRedirectURIs
array
Where the authorization code may be delivered. Every URI must be an absolute https URL with no fragment, and must match the one the platform sends exactly.
AdminOAuthClientScopeAllowlist
array
The scopes this client may ask a user for. Every entry names a workspace scope a user can delegate, without an access level: organization and admin scopes are…
AdminOAuthClient
object
A confidential OAuth client Bird registers for a platform integration. Its secret is never readable after the response that minted it.
11 properties
11 required
AdminOAuthClientList
object
1 property
1 required
AdminOAuthClientCreate
object
4 properties
3 required
AdminOAuthClientWithSecret
AdminOAuthClientUpdate
object
Only the properties present in the request are changed.
4 properties
AdminOAuthClientRotateSecret
object
1 property
ExternalIdentity
object
A social identity (Google or GitHub) connected to the user's account.
4 properties
2 required
ExternalIdentityList
object
The social identities connected to the user's account.
1 property
SocialStartResponse
object
Returned when a social login flow is started.
2 properties
2 required
SocialAuthResult
object
The result of a social login callback or email verification.
8 properties
1 required
SocialEmailRequest
object
Submits an email address to verify when a social account had no verified email.
3 properties
3 required
SSOLookupRequest
object
Identifies the sign-in domain to check for enterprise single sign-on.
1 property
1 required
SSOProtocol
string
The protocol a single sign-on connection speaks. oidc uses OpenID Connect with an authorization-code flow; saml uses SAML 2.0. A connection's protocol is fixed…
SSOConnection
object
A single sign-on connection available for the requested domain.
4 properties
4 required
SSOLookupResponse
object
The single sign-on availability for a sign-in domain.
2 properties
2 required
SessionLocation
object
Approximate location of a session, resolved from its IP address.
3 properties
SessionInfo
object
11 properties
4 required
SessionList
object
All active sessions, ordered by createdat descending. This list is not paginated.
1 property
1 required
VerifyDeviceOTPRequest
object
3 properties
2 required
DeviceOTPVerifyResponse
object
Returned when device OTP verification succeeds. A session cookie is set via Set-Cookie. When trustdevice was true in the request, a device trust cookie is also…
1 property
1 required
ResendDeviceOTPRequest
object
1 property
1 required
MFAEnrollRequest
object
3 properties
1 required
MFAEnrollTOTPDetails
object
TOTP enrollment details. Present only when type is totp.
3 properties
MFAChallengeID
string
MFAEnrollSMSDetails
object
SMS enrollment details. Present only when type is sms.
2 properties
MFAEnrollResponse
object
3 properties
1 required
MFAEnrollVerifyRequest
object
3 properties
2 required
MFAFactorStatus
string
Lifecycle status of an MFA factor.
MFAEnrollVerifyResponse
object
3 properties
2 required
MFAEnrollResendRequest
object
2 properties
2 required
MFAEnrollResendResponse
object
1 property
1 required
MFAChallengeRequest
object
2 properties
2 required
MFAChallengeResponse
object
2 properties
1 required
MFAVerifyRequest
object
4 properties
1 required
MFAVerifyResponse
object
2 properties
1 required
MFAFactor
object
6 properties
4 required
MFAFactorList
object
1 property
1 required
MFARecoveryCodesStatus
object
2 properties
2 required
MFARecoveryCodesResponse
object
1 property
SMSCountry
object
3 properties
3 required
SMSCountryList
object
1 property
1 required
WebAuthnChallengeID
string
WebAuthnRegisterStartResponse
object
2 properties
2 required
WebAuthnAssertion
object
WebAuthnRegisterCompleteRequest
object
3 properties
3 required
WebAuthnCredentialID
string
WebAuthnCredential
object
5 properties
4 required
WebAuthnRegisterCompleteResponse
object
2 properties
1 required
WebAuthnCredentialList
object
1 property
1 required
WebAuthnCredentialRenameRequest
object
1 property
1 required
WebAuthnAuthenticateStartRequest
object
1 property
1 required
WebAuthnAuthenticateStartResponse
object
2 properties
2 required
WebAuthnAuthenticateCompleteRequest
object
3 properties
3 required
WebAuthnAuthenticateCompleteResponse
object
1 property
1 required
WebAuthnPasswordlessCompleteRequest
object
2 properties
2 required
StepUpMethod
object
4 properties
1 required
StepUpMethodsResponse
object
1 property
1 required
StepUpChallengeRequest
object
2 properties
1 required
StepUpChallengeResponse
object
2 properties
1 required
StepUpWebAuthnStartResponse
object
2 properties
2 required
StepUpVerifyRequest
object
6 properties
1 required
DocsSearchResult
object
10 properties
8 required
DocsSearchResponse
object
3 properties
3 required
DocsPage
object
4 properties
4 required
DmarcUnknownTag
object
A tag present in the DMARC record that this model does not interpret, preserved verbatim.
2 properties
1 required
DmarcPolicy
object
A parsed DMARC policy, with the tags the record sets. Tags left at their RFC 7489 default are omitted.
12 properties
3 required
DmarcIssue
object
A validation error or warning about a single part of the DMARC record.
2 properties
1 required
DmarcValidationResult
object
The result of validating a DMARC record, with the parsed policy and any errors and warnings.
4 properties
3 required
BimiUnknownTag
object
A tag present in the BIMI record that this model does not interpret, preserved verbatim.
2 properties
1 required
BimiRecord
object
A parsed BIMI record.
3 properties
BimiIssue
object
A validation error or warning about a single part of the BIMI record.
2 properties
1 required
BimiValidationResult
object
The result of validating a BIMI record, with the parsed record and any errors and warnings.
4 properties
3 required
DnsSplitResult
object
A long DNS TXT value split into DNS-safe (≤255-octet) chunks.
7 properties
7 required
AnalyzeEmailHeadersRequest
object
A raw email to analyze.
1 property
1 required
EmailHeaderSummary
object
The headline header fields most people scan a message for. Every field is absent when the message does not have it.
9 properties
EmailAuthResult
object
One authentication verdict (SPF, DKIM, or DMARC) parsed from an Authentication-Results or Received-SPF header.
3 properties
2 required
EmailAuthSummary
object
The SPF, DKIM, and DMARC verdicts found in the message's authentication headers.
4 properties
1 required
EmailReceivedHop
object
One Received relay hop, parsed and placed in delivery order (oldest first).
8 properties
2 required
EmailHeaderAnalysis
object
What we found in a raw email's headers. The headline fields, the authentication results, and the path the message took to get here.
5 properties
4 required
AnalyzeDmarcReportRequest
object
A DMARC aggregate report to analyze.
1 property
1 required
DmarcDispositionCount
object
How many messages a receiver applied a given DMARC disposition to.
2 properties
2 required
DmarcSourceSummary
object
A per-source-IP breakdown of the mail in a DMARC aggregate report.
9 properties
9 required
DmarcFinding
object
One plain-language observation drawn from a DMARC aggregate report.
2 properties
2 required
DmarcReportAnalysis
object
Analysis of a DMARC aggregate (RUA) report, including totals, a per-source breakdown, and plain-language findings.
9 properties
9 required
EmailAuthArea
string
Which part of a domain's email setup this record covers. - dmarc: The domain's DMARC policy record. - spf: The domain's SPF record. - dkim: A DKIM selector's p…
EmailAuditRecord
object
The resolved state of one email-authentication record.
3 properties
2 required
AuditFinding
object
A single finding about one area of a domain's email authentication.
4 properties
3 required
EmailAuditResult
object
The result of auditing a domain's email authentication.
5 properties
5 required
AdminAssistantKnowledgeStatus
string
Publication state of a curated Ask Bird entry. - draft is the default, editable state and is excluded from customer retrieval. - waitingapproval is awaiting st…
AssistantKnowledgeID
string
AdminAssistantKnowledge
object
Curated global Ask Bird knowledge and its latest editor.
10 properties
10 required
AdminAssistantKnowledgeList
A page of global curated knowledge.
AdminAssistantKnowledgeInput
object
Curated knowledge to save. An omitted status starts as draft.
5 properties
3 required
AdminAssistantKnowledgeUpdate
object
Full replacement guarded by the last observed revision.
2 properties
2 required
AdminAssistantKnowledgeImport
object
Bounded JSON import. Invalid or duplicate keys reject the complete batch.
2 properties
2 required
AdminAssistantKnowledgeImportChange
string
Difference between an imported entry and the saved entry.
AdminAssistantKnowledgeImportPreviewEntry
object
Normalized import entry and its observed revision.
3 properties
3 required
AdminAssistantKnowledgeImportPreview
object
Validated import preview. Submit these entries to apply the complete batch atomically.
2 properties
2 required
AdminAssistantKnowledgeImportResult
object
Entries returned by a successful atomic import.
1 property
1 required
AssistantConversationID
string
AssistantConversation
object
A saved conversation private to its owner and workspace.
6 properties
6 required
AssistantMessageID
string
AdminAssistantConversation
object
Customer conversation summary for an authorized regional staff reader.
10 properties
9 required
AdminAssistantConversationList
Audited customer content from the selected region.
AdminAssistantReportNavigation
object
Position and neighboring reports for the selected answer in conversation order.
5 properties
3 required
AssistantRunID
string
AssistantRunTerminalReason
string
Sanitized reason a request ended. Omitted when no terminal reason was recorded. stopped: The request was stopped. expired: The request exceeded its execution d…
AssistantRunState
string
Current state of an Ask Bird request. admitting means allowance reservation is pending; retry the original start with the same request key and input. ready acc…
AdminAssistantRetrievalTrigger
string
Retrieval trigger.
AdminAssistantRetrievalSource
string
Retrieval source.
AdminAssistantRetrievalStatus
string
Retrieval status.
AdminAssistantRetrievalMode
string
Search strategy. hybrid combines vector similarity and keyword matching; keyword uses text matching without a query embedding.
AdminAssistantRetrievalReference
object
Identity and version of evidence supplied by retrieval.
2 properties
2 required
AdminAssistantRetrieval
object
A bounded search attempt and the evidence supplied to the agent.
8 properties
7 required
AdminAssistantModelOutcome
string
Bounded result of this provider attempt. Accepted output does not establish that a tool ran or an answer reached the customer. answer: The structured answer an…
AdminAssistantProviderErrorCode
string
Allowlisted provider error code; other replaces an unrecognized code.
AdminAssistantServiceTier
string
Inference service tier.
AdminAssistantModelTokens
object
Provider-reported token usage. Billable output includes thinking tokens in Gemini total usage.
5 properties
4 required
amount
string
Decimal amount as a string, in major currency units.
CurrencyCode
string
ISO 4217 three-letter currency code.
AdminAssistantModelCostTierBasis
string
Whether the calculation uses a provider-reported tier or the requested tier when unreported.
AdminAssistantModelRates
object
Published rates per million tokens, in the estimate's currency. Decimal strings preserve the supplied precision.
3 properties
3 required
AdminAssistantModelCost
object
Estimated inference cost for this attempt, not an invoiced charge. Excludes embeddings, cache storage, taxes, and negotiated adjustments.
10 properties
9 required
AdminAssistantModelAccounting
object
Model usage and inference experiment metadata. Missing usage or cost is unknown, never zero.
5 properties
1 required
AdminAssistantModelCall
object
One observed provider attempt using the model configured at execution time.
10 properties
7 required
AdminAssistantDiagnosticSource
string
Execution boundary that recorded the failure.
AdminAssistantDiagnosticCode
string
Bounded failure classification. An entry can precede a successful recovery; the request's current state and terminal reason remain separate. expired: The reque…
AdminAssistantDiagnosticTool
string
Allowlisted tool name when the failure belongs to a tool operation.
AdminAssistantDiagnosticError
object
Sanitized runtime or tool failure without raw error text or customer content.
5 properties
4 required
AdminAssistantCostSummary
object
Sum of retained per-attempt estimates in one currency. Absent if no attempts are priced or currencies differ. Active requests can accumulate more cost.
5 properties
5 required
AdminAssistantExecutionDiagnostics
object
Bounded execution history retained through retries, completion, and temporary-context expiry. Does not establish which errors the customer saw.
5 properties
3 required
AdminAssistantExecutionSummary
object
Recorded state of a request in this conversation. Completion does not establish that the customer's issue was resolved.
7 properties
4 required
AssistantCitation
object
A source verified against the passages retrieved for this answer.
4 properties
4 required
AssistantMessage
object
An immutable committed message with independently editable feedback.
16 properties
9 required
AdminAssistantConversationDetail
Audited customer content from the selected region.
AssistantConversationList
An owner-scoped page of conversation summaries.
AssistantBrowserVerb
string
One operation in the current Bird tab.
AssistantBrowserOperation
object
An operation bound to the observed Bird page and control.
5 properties
5 required
AssistantHelpView
string
A companion view to open without submitting a form.
AssistantActionID
string
AssistantPendingOperation
object
The single external operation awaiting browser execution or review.
4 properties
1 required
AssistantActionState
string
Dispatch and outcome state. proposed awaits review and may be declined or claimed. claimed has granted one caller permission to submit; a replay never grants p…
AssistantReviewValue
object
A meaningful value in the native operation review.
2 properties
2 required
AssistantReview
object
The exact operation and values the customer reviews.
4 properties
4 required
AssistantAction
object
An immutable proposal and the observed outcome of its one dispatch claim.
5 properties
3 required
AssistantRun
object
Current request state and its committed messages. Reading it performs no inference.
11 properties
8 required
AssistantConversationDetail
Saved conversation with a page of committed messages and any active request.
UpdateAssistantConversation
object
Explicit revision-guarded archive or restore.
2 properties
2 required
AssistantVote
string
Selected vote, or none to clear it.
UpdateAssistantFeedback
object
Feedback on one exact committed assistant answer. Published answer content is unchanged.
4 properties
4 required
CreateAssistantReport
object
A report about one exact immutable assistant answer.
3 properties
3 required
CreateAssistantHandoff
object
Prepare an immutable Support submission for customer review.
5 properties
4 required
AssistantHandoff
object
Canonical Support preparation and verified submission state.
10 properties
8 required
SubmitAssistantHandoff
object
Submit the exact reviewed Support handoff once.
1 property
1 required
AssistantNavigationEntry
object
A permitted application menu destination, including pages that require manual operation.
4 properties
3 required
AssistantNavigation
object
Current permitted menu locations for guidance and customer-click links. These entries do not grant browser control.
2 properties
2 required
AssistantControlOption
object
An available option in an observed native control.
2 properties
2 required
AssistantControlBehavior
string
Effect semantics supplied by the native Bird control.
AssistantBrowserControl
object
A bounded, visible native control with a short-lived reference.
9 properties
7 required
AssistantDestination
object
A permitted Bird destination.
2 properties
2 required
AssistantPageContext
object
Sanitized current-tab evidence. Page content does not grant permission to act.
8 properties
7 required
CreateAssistantRun
object
One immutable customer intent. Retain the key and creation time for retries.
5 properties
4 required
AssistantToolResult
object
Observed result of the exact pending browser operation.
5 properties
3 required
AdvanceAssistantRun
object
Advance one request revision; include a result only for its matching unclaimed external operation.
2 properties
1 required
ClaimAssistantAction
object
Claim dispatch once for the exact review the customer approved.
2 properties
2 required
AssistantDispatch
object
Only a winning external claim grants dispatch. A repeated claim never grants it again.
2 properties
2 required
AssistantActionDisposition
string
Observed final or uncertain outcome of the proposed action.
RecordAssistantActionResult
object
Record the outcome without repeating the product operation.
2 properties
2 required
SupportChatMessageAttachment
object
5 properties
2 required
SupportChatThreadMessage
object
6 properties
3 required
SupportTicket
object
6 properties
4 required
SupportTicketList
object
1 property
1 required
CreateSupportTicket
object
Either message or attachmentids (or both) must be provided.
7 properties
CreateSupportTicketMessage
object
Either text or attachmentids (or both) must be provided.
2 properties
SupportTicketMessageResult
object
1 property
1 required
SupportTicketUnread
object
1 property
1 required
SupportChatAttachmentUploadFormData
object
2 properties
2 required
SupportChatAttachmentUploadUrl
object
3 properties
3 required
SupportSlackChannel
object
The private Slack channel provisioned for your organization's support conversations with the Bird team.
4 properties
2 required
DestinationRegion
stringnull
The commercial region this country belongs to, for grouping a destination list the way it is bought rather than alphabetically. null for a country we have not…
CountryPolicy
object
11 properties
9 required
CountryPolicyList
object
2 properties
2 required
CountryCode
string
ISO 3166-1 alpha-2 country code.
MessagingContextPlatform
object
23 properties
2 required
SMSRegistrationProgram
string
The registration program a country runs for a sender type. - 10dlc: US A2P brand and campaign registration. - tfn: US toll-free verification. - alpha: register…
MessagingContextSenderType
object
16 properties
8 required
MessagingContext
object
4 properties
4 required
EgressIPPrefix
object
1 property
1 required
EgressIPList
object
4 properties
4 required
WorkspaceNotificationEmails
object
1 property
Timestamps
object
2 properties
2 required
Workspace
WorkspaceUpdate
object
2 properties
WorkspaceEmailSettings
object
1 property
1 required
WorkspaceSettings
object
1 property
1 required
WorkspaceEmailSettingsUpdate
object
1 property
WorkspaceSettingsUpdate
object
1 property
NotificationEmails
object
2 properties
Organization
OrganizationUpdate
object
2 properties
OrganizationClosureCancelRequest
object
1 property
1 required
Address
object
A postal address.
5 properties
4 required
ContactInformation
object
Primary contact details for an organization.
3 properties
BusinessProfile
object
The organization's business profile. Returns default values (name and legalname empty, businesstype set to unknown) if none has been configured.
8 properties
2 required
BusinessProfileUpdate
object
Request body for updating the business profile. Every field is optional; omitted fields are left unchanged. The registration address, billing address, and cont…
6 properties
ComplianceIdentityID
string
BusinessProfileCopyFromIdentityRequest
object
Names the compliance party whose details should be copied onto the business profile.
1 property
1 required
Quota
object
A quota's effective limit and current usage.
9 properties
9 required
QuotaList
object
1 property
1 required
RateLimit
object
An organization's effective rate and window for a rate-limit policy.
5 properties
5 required
RateLimitList
object
1 property
1 required
WorkspaceList
WorkspaceCreate
object
1 property
1 required
OrganizationWorkspaceUpdate
object
1 property
APIKeyID
string
ApiKeyScope
object
2 properties
2 required
ApiKey
object
13 properties
10 required
ApiKeyList
ApiKeyCreate
object
4 properties
2 required
ApiKeyUpdate
object
2 properties
RealtimeRegion
object
1 property
1 required
RealtimeRegionList
object
1 property
1 required
RealtimeAppSortField
string
Field to sort Realtime apps by.
RealtimeAppID
string
RealtimeApp
RealtimeAppList
RealtimeAppConfig
object
Realtime app configuration flags. TLS is always enforced (non-TLS client connections are rejected) and is not configurable.
5 properties
RealtimeAppCreate
RealtimeAppKeyID
string
RealtimeAppKey
object
5 properties
4 required
RealtimeAppCreated
RealtimeUsageMetric
object
A usage metric over the selected window and the immediately preceding window of equal length. Values use the double format because averageconnections can be fr…
2 properties
1 required
RealtimeUsageSummary
object
3 properties
3 required
RealtimeUsageDailyPoint
object
Usage for one UTC day. peak/average connections are over that day's buckets; messages is that day's total.
4 properties
4 required
RealtimeUsageAppRow
object
Per-app usage over the window.
6 properties
6 required
RealtimeUsage
object
Realtime usage for a workspace over a time window, including summary metrics, a daily series, and a per-app breakdown. For display only; not a billing source.
4 properties
3 required
RealtimeAppUpdate
object
Mutable Realtime app fields. Omitted fields are left unchanged. Region is immutable and TLS is always enforced, so neither appears here.
6 properties
RealtimeEventName
string
The event name clients bind to. Application event names are free-form; the bird: and birdinternal: prefixes are reserved for the protocol and rejected.
RealtimeChannelName
string
A Realtime channel name. Only letters, digits, and - = @ , . ; Prefix with private- or presence- for authenticated channels, or private-encrypted- for channels…
RealtimeEventData
Arbitrary JSON payload delivered as the event data: an object, array, or scalar. Cap: 10 KB serialized.
RealtimeExcludeConnectionId
string
Exclude this connection from delivery, to avoid echoing a change back to the client that triggered it. The value is the client's connection id, assigned when i…
RealtimeChannelInclude
string
A per-channel attribute to include in the response. membercount is presence-channels only; connectioncount requires the app's connection-counting flag.
RealtimePublish
object
A Realtime publish: delivers one event to one or more channels of the app. Listing several channels fans the event out to all of them (broadcast) in a single c…
5 properties
2 required
RealtimeChannelCounts
object
Per-channel counts, present only when requested via include and applicable.
2 properties
RealtimeChannelListItem
RealtimePublishResult
object
The result of a Realtime publish. The event was accepted and fanned out to the requested channels; delivery to connected clients is asynchronous.
1 property
RealtimeBatchEvent
object
A single event published to one channel as part of a batch.
5 properties
2 required
RealtimeBatchPublish
object
A batch of events, each delivered to a single channel, in one request.
1 property
1 required
RealtimeBatchPublishResultItem
RealtimeBatchPublishResult
object
The result of a Realtime batch publish. The events were accepted for delivery; delivery to connected clients is asynchronous.
1 property
RealtimeChannelsList
object
The app's occupied channels. The Realtime service does not paginate this listing, so all occupied channels are returned in one response.
1 property
1 required
RealtimeChannelInfo
RealtimeMemberID
string
An app-defined member ID for your application's end user, assigned when your auth server authorizes them. Use up to 128 URL-safe characters because member IDs…
RealtimeChannelMember
object
A member present on a presence channel.
1 property
1 required
RealtimeChannelMembers
object
The members present on a presence channel.
1 property
1 required
RealtimeMemberPublish
object
An event addressed to one member rather than to a channel. Every connection that member currently holds receives it; if they hold none, the event is dropped.
2 properties
1 required
RealtimeAppKeyList
object
1 property
1 required
ApiKeyRotate
object
Options for rotating an API key.
2 properties
ApiKeyIpRestrictions
object
The API key's current IP allowlist configuration.
2 properties
2 required
ApiKeyIpRestrictionsUpdate
object
Replaces the API key's IP allowlist. Requests from any address outside the listed ranges are denied.
1 property
1 required
ServiceAccountID
string
ServiceAccountStatus
string
Lifecycle of the integration. - active (the initial status) means the integration holds at least one live connection. A connection whose access lapsed can take…
ServiceAccountConnectionStatus
string
Lifecycle of the connection. active (the initial status) means the connection holds a live approval. revoked means the connection was revoked or its access lap…
ServiceAccountConnection
object
One connection of an integration: a grant of access approved from the platform's consent flow, with the scopes it currently carries.
6 properties
4 required
ServiceAccount
object
A platform integration connected to the workspace: a machine identity that acts through the connections listed on it, independent of the user who set it up.
6 properties
5 required
ServiceAccountList
object
The workspace's platform integrations.
1 property
1 required
MemberUser
object
A user's basic profile, as shown alongside their membership in a workspace.
4 properties
2 required
WorkspaceRole
object
3 properties
3 required
OrganizationMember
object
6 properties
4 required
OrganizationMemberList
OrganizationMemberUpdate
object
1 property
1 required
Member
object
A user's access to this workspace, granted directly or inherited from organization ownership.
3 properties
3 required
MemberList
MemberAdd
object
Parameters for granting an existing organization member a role on this workspace.
2 properties
2 required
MemberUpdate
object
Fields to update on a workspace membership.
1 property
1 required
Invitation
object
An invitation for someone to join a workspace, sent by email.
8 properties
8 required
InvitationList
MemberCreate
object
Parameters for adding a member to this workspace by email.
2 properties
2 required
SmartInviteTeamMember
object
5 properties
5 required
SmartInviteInvitation
object
6 properties
6 required
SmartInviteResponse
The member added directly, or the invitation created when no matching member exists. type tells them apart.
OrganizationInvitationList
OrganizationInvitationCreate
object
3 properties
1 required
EmailMessageStatus
string
Aggregate delivery status of an email, derived from its recipients' states. In flight: - scheduled: The message is queued to send at a future time and has not…
EmailMessageCategory
string
Content classification, which controls suppression policy: - marketing: Blocks on all suppression reasons. - transactional: Allows delivery through complaint a…
EmailID
string
EmailAddress
object
An email address with an optional display name.
2 properties
1 required
LanguageTag
string
A language tag in BCP-47 form, for example en or pt-BR.
EmailTemplateID
string
EmailTemplateVersionID
string
EmailBroadcastID
string
Tag
object
Structured key/value label attached to a message or a call. Use tags for low-cardinality filtering dimensions (category, experiment ID, template ID); they surf…
2 properties
2 required
EmailAttachmentID
string
EmailAttachmentRef
object
Attachment metadata returned on API reads. Download the file during its retention window with GET /v1/email/messages/{messageid}/attachments/{attachmentid}.
6 properties
2 required
EmailMessage
object
An email message, including a recipient's copy of a broadcast. broadcastid identifies the broadcast that sent the message and is absent for other sends. A broa…
37 properties
18 required
EmailMessageList
EmailAddressInput
A sender or recipient address. Accepts a plain email string (jane@acme.com), an RFC 5322 mailbox string with an embedded display name (Jane Doe ), or an object…
TemplateSlug
string
A template's slug: what you send it by, for example welcome-email. Email and SMS slugs stay fixed after creation. WhatsApp slugs can change only before the fir…
EmailTemplateSend
object
A reference to the template to send. Identify the template by its id or its slug, supplying exactly one of the two, and give the values for its variables in pa…
4 properties
EmailAttachment
object
A file attached to an email. Put the base64-encoded bytes in content and the recipient-facing name in filename. To show an image inline, set contentid and refe…
4 properties
2 required
EmailMessageSendRequest
object
19 properties
2 required
EmailMessageBatchRequest
object
Batch of email message send requests.
1 property
1 required
EmailMessageBatchItem
object
8 properties
3 required
EmailMessageBatchResponse
object
1 property
1 required
RecipientID
string
RecipientRole
string
Envelope position of a recipient on an outbound email event.
EmailRecipient
object
17 properties
7 required
EmailRecipientList
EmailEventType
string
Type of an event in a message's per-recipient delivery timeline. - email.scheduled: We accepted a send scheduled for a future time. Fires once for each message…
EmailEvent
object
18 properties
4 required
EmailEventList
EmailMessageContent
object
The body content of a sent email message, as delivered. A send that used a template stores the template's body, so these report it with the send's parameters s…
2 properties
EmailSendQuotaWindow
object
One window of the send allowance, with the cap in force over it and how much of that cap the window has spent.
5 properties
5 required
EmailSendQuota
object
How much of the organization's email send allowance is spent, in each of the two windows a send is measured against. Use it to show a sender how close they are…
2 properties
2 required
EmailBroadcastStatus
string
Where the broadcast itself has got to. This is separate from what happened to individual recipients, which the broadcast's own sentcount, deliveredcount, bounc…
AudienceID
string
EmailBroadcastTemplate
object
The template a broadcast sends, and the exact version of it the broadcast is fixed to. The template cannot be one that requires every send to name a language,…
2 properties
1 required
EmailBroadcast
object
35 properties
8 required
EmailBroadcastList
EmailBroadcastCreateRequest
object
A broadcast sends one email to a whole audience. Every field here is optional, so you can create an empty draft and fill it in later. To actually send, a broad…
13 properties
EmailBroadcastUpdateRequest
object
Changes a broadcast that is still a draft or is scheduled. Whatever you send here is applied, and anything you leave out keeps the value it already had. Once a…
11 properties
EmailBroadcastCounts
object
How many people a broadcast would reach right now, narrowing from everyone in the audience down to the ones it could actually be sent to. These are live number…
6 properties
5 required
EmailSendAllowanceWindow
string
Which of the organization's email send allowances stops a send from reaching its whole audience. - none: every recipient is covered. - monthly: the allowance t…
EmailBroadcastSendQuota
object
How much of a broadcast the organization's email send allowance covers, read before the broadcast is sent. The allowance is shared with every other email the o…
5 properties
3 required
EmailAudienceCounts
object
How many contacts an audience has an address for, and how many of those a marketing email is effectively sent to, narrowing from every member down to the ones…
3 properties
3 required
EmailBroadcastClickedLink
object
One destination URL a broadcast's recipients clicked, with its exact click and recipient totals. Grouped over every click event the broadcast has, not a sample.
4 properties
4 required
EmailBroadcastClickedLinkList
object
2 properties
2 required
EmailBroadcastSendNowRequest
object
1 property
ContactIdentifierFilter
string
Which identifier a contact has on file, email for an email address or phonenumber for a phone number.
ContactID
string
AudienceRef
object
A compact reference to an audience, carrying its ID and display name.
2 properties
2 required
Contact
ContactList
ContactCreateRequest
object
6 properties
ContactMatchKey
string
A contact identifier a batch entry can be matched on.
ContactUpsertRequest
object
4 properties
1 required
ContactUpsertEntry
object
The identifiers a batch entry supplied, in the normalized form used for matching. A field is null when the entry did not include it. These values identify the…
3 properties
3 required
ContactMatchedOn
stringnull
Which identifier matched a batch entry to an existing contact. null when the entry created a new contact.
ContactUpsertError
object
3 properties
3 required
ContactUpsertResultItem
object
5 properties
3 required
ContactUpsertResult
object
1 property
1 required
ContactUpdateRequest
object
6 properties
Audience
AudienceList
PreferenceID
string
PreferenceChannel
string
The channel a preference statement applies to. A preference addresses one channel: the handle that identifies the person differs per channel, so opting out of…
PreferenceStatus
string
What the statement says: granted records consent to receive messages, revoked records an opt-out. There is no third state: a person who never stated anything s…
PreferenceCoverage
string
How much traffic the statement covers. nontransactional covers marketing and other non-essential messages while transactional messages such as receipts and ver…
PreferenceOrigin
string
How the statement was made. Statements the person made themselves (unsubscribelink, unsubscribeevent, keyword, preferencepage) carry more weight than ones asse…
Preference
One person's current stated preference for one channel: whether they have consented to or opted out of receiving messages at a handle, and how much traffic the…
PreferenceList
PreferenceStatement
object
6 properties
2 required
PreferenceCreate
Records one preference statement for a handle. Writing is an upsert by key (channel, handle, sender scope, and topic), and statements are causally ordered: a s…
PreferenceTransitionID
string
PreferenceWriteResult
object
The outcome of one preference write or delete. applied: true means the request took effect: either it changed the record, or an identical statement already had…
3 properties
3 required
PreferenceBulkCreate
object
1 property
1 required
PreferenceBulkOutcome
string
What happened to this row. - created: applied, and this statement changed the key's current record (a fresh transition, whether the key had no prior record or…
ErrorType
string
Machine-readable error category for coarse client branching, the closed vocabulary shared by the top-level error type and per-row bulk errors.
BulkRowError
object
3 properties
3 required
PreferenceBulkResultItem
object
One row's result. Which optional fields accompany the outcome is stated per field rather than encoded as a oneOf: outcome is an extensible enum, so a closed di…
4 properties
1 required
PreferenceBulkResult
object
1 property
1 required
ContactPropertyID
string
ContactPropertyType
string
The value type every contact must use for a property. Cannot be changed after creation. datetime values are RFC 3339 timestamps with an explicit offset. Exampl…
ContactProperty
ContactPropertyList
ContactPropertyCreateRequest
object
3 properties
2 required
ContactPropertyUpdateRequest
object
1 property
AudienceCreateRequest
object
3 properties
1 required
AudienceUpdateRequest
object
2 properties
AudienceMember
object
3 properties
2 required
AudienceMemberList
AudienceContactsAddRequest
object
1 property
1 required
AudienceContactsRemoveRequest
object
1 property
1 required
MessageDirection
string
Whether a message was sent from the workspace (outbound) or received by it (inbound).
SMSMessageCategory
string
Content classification: why you are sending. Carriers see it, and where a destination country requires the sender to be registered, that registration is approv…
SMSMessageID
string
SMSMessageStatus
string
Delivery status: - accepted: Accepted and awaiting carrier handoff. - sent: Handed to the carrier and awaiting a delivery receipt. - delivered: Confirmed as de…
SMSTemplateID
string
SMSTemplateVersionID
string
SMSTemplateContentHash
string
A fingerprint of SMS template text, prefixed with its algorithm. Compare it within this API version to identify the exact source without transferring it.
SMSSegments
object
Segment breakdown for the message body. Segment count drives billing.
3 properties
3 required
MessageCost
objectnull
What was charged for a message, split into the components that make it up. null until at least one component has been priced.
4 properties
4 required
SMSMessageEffectiveOptions
object
The settings Bird applied to this message. Every option is reported, whether you set it on the send or took the default that was in force at the time.
1 property
1 required
SMSErrorCode
string
Standardized failure reason: - invaliddestination: The number is unassigned, ported out, or malformed. - unreachable: The handset is off or outside coverage. -…
SMSError
objectnull
Failure detail for a message that could not be delivered or was rejected.
4 properties
3 required
SMSMedia
object
A media attachment on a received MMS. Bird records what arrived, its media type and the sender's filename, so you can tell an attachment came in and what it is.
3 properties
1 required
SMSMessage
object
24 properties
12 required
SMSMessageList
SMSSendOptions
object
Settings that change how Bird processes this message. Each option applies to this send only; omit one to use its default.
3 properties
SMSTemplateSend
object
A send-by-template reference. Identify the template by id or slug, or use the deprecated name for a legacy built-in template. Supply exactly one reference, opt…
5 properties
SMSMessageSendRequest
object
A message to send. Supply exactly one of text (free-text, which also requires category) or template (a stored template, whose category is derived). Supplying b…
18 properties
1 required
SMSMessageBatchRequest
object
Batch of SMS message send requests.
1 property
1 required
SMSBatchSummary
object
Aggregate result for an SMS batch.
1 property
1 required
SMSMessageBatchResponse
object
2 properties
2 required
SMSEvent
object
6 properties
3 required
SMSEventList
object
1 property
1 required
TemplateScope
string
Whether the template is one of our built-in templates (system) or one your workspace created (workspace).
SMSTemplateCategory
string
Why messages use this template. Use authentication for one-time codes, marketing for promotions, and transactional for service messages.
TemplateStatus
string
Where the template stands as a whole. The same five states on every channel. - draft: nothing has ever gone live. - pending: nothing is live and at least one l…
SMSTemplateSortField
string
Field to sort SMS templates and their versions by.
TemplateLanguageStatus
string
Status of one template language on channels without third-party review. - draft: it has never been published. - live: it is available to sends. - superseded: a…
SMSTemplateLanguageState
object
Whether a language is live and whether its draft has unpublished changes.
2 properties
1 required
SMSTemplateSummary
object
An SMS template without content or draft concurrency settings.
17 properties
17 required
SMSTemplateList
SMSTemplateText
string
SMS template text, limited to 16 KiB of UTF-8 source. Blank text can be saved in a draft but cannot be published. Workspace templates support scalar variables,…
SMSTemplateLanguageContent
object
The editable SMS text for one language.
1 property
1 required
TemplateOnMissingLanguage
string
What a send or a preview does when it asks for a language the template cannot serve. fallback serves the closest match instead. It tries a broader form of the…
SMSTemplateCreate
object
Parameters for creating an SMS template and its permanent draft.
8 properties
2 required
SMSTemplate
object
One SMS template identity and its authoring state. Content and variables live on versions, so this resource stays shallow.
20 properties
20 required
SMSTemplateDraftRevision
integer
The draft revision last read from the template. A stale value returns a conflict so the caller can reload and retry.
SMSTemplateUpdate
object
Template metadata and draft settings to change.
6 properties
1 required
SMSTemplateDuplicate
object
Optional settings for an SMS template copy.
1 property
SMSTemplatePreviewOptions
object
Rendering options for this SMS template preview.
1 property
SMSTemplatePreviewRequest
object
Sample values, language selection, and rendering options for an SMS template preview.
4 properties
TemplateVariable
object
A single variable slot a template fills in from the values supplied when sending. The same shape on email, SMS and WhatsApp, so reading what a template needs w…
5 properties
4 required
SMSTemplatePreview
object
Rendered SMS template text with its segment calculation and source provenance.
7 properties
7 required
SMSTemplateVersionStatus
string
Whether the version is the editable draft or published. Published workspace versions are immutable and remain published after a later version goes live. A buil…
SMSTemplateVersionSummary
object
One SMS template version without its text.
10 properties
10 required
SMSTemplateVersionList
SMSTemplateVersionLanguage
object
One language's content and revision metadata within a version.
4 properties
4 required
SMSTemplateVersion
object
One SMS template version with its content. A workspace template keeps one editable draft and immutable published versions. A built-in template exposes its curr…
10 properties
10 required
SMSTemplateLanguageSummary
object
One language of an SMS template version without its text.
4 properties
4 required
SMSTemplateLanguageList
object
1 property
1 required
SMSTemplateLanguage
object
One language's full SMS template text and revision metadata.
5 properties
5 required
SMSTemplateLanguageUpsert
object
Complete text for one draft language and an optional concurrent-edit guard.
2 properties
1 required
SMSTemplateRef
The template a call addressed, returned as its ID even when the request used a slug. Send it back as templateref on a later call.
SMSTemplateLanguageSaved
object
The identifiers, new revisions, and content hash of a saved draft language.
7 properties
7 required
SMSTemplateLanguageUpdate
object
New text for an existing draft language and an optional concurrent-edit guard.
2 properties
1 required
SMSTemplateRollback
object
The draft revision required to roll an SMS template back.
1 property
1 required
SMSTemplateSubmit
object
Options for validating or publishing the complete SMS template draft.
2 properties
SMSTemplateSubmitProblem
object
One problem found while checking whether an SMS template draft can be published.
4 properties
4 required
SMSTemplateSubmitResult
object
The outcome of validating or publishing an SMS template draft.
3 properties
3 required
SMSSuppressionReasonFilter
string
SMSSuppressionID
string
SMSSuppressionReason
string
Reason this sender cannot message the subscriber: - keywordstop: The subscriber sent a stop keyword. A start keyword clears it. - carrieroptedout: The carrier…
SMSSuppressionOrigin
string
How the opt-out reached us: - keyword: an inbound message from the subscriber. - dlrevent: a carrier delivery report. - apikey: an API call. - user: someone ac…
SMSSuppressionCoverage
string
Message categories blocked for this sender and subscriber. all blocks every category, including authentication and transactional messages. nontransactional blo…
SMSSuppressionEndReason
string
What ended it: - keywordstart: the subscriber texting a start keyword to the same sender. - apikey: an API call. - user: someone acting in the dashboard. - car…
SMSSuppression
object
One period during which a sender's messages to a subscriber are stopped: when it started, what started it, and what ended it. A subscriber who opts out, opts b…
15 properties
10 required
SMSSuppressionList
SMSSuppressionCreate
object
Stops one sender's messages to one subscriber. Both ends are required, because a suppression covers a sender-and-subscriber pair rather than a subscriber alone.
2 properties
2 required
SMSSuppressionBulkCreate
object
1 property
1 required
SuppressionBulkOutcome
string
What happened to this row. - created: a new suppression was recorded for this row. - alreadysuppressed: a suppression for this row already existed and is retur…
SMSSuppressionBulkResultItem
object
One row's result. Which optional fields accompany the outcome is stated per field rather than encoded as a oneOf: outcome is an extensible enum, so a closed di…
3 properties
1 required
SMSSuppressionBulkResult
object
1 property
1 required
SMSKeywordOperation
string
What Bird does when an inbound message matches the rule. - stop unsubscribes the sender from further messages. - start resubscribes them. - help replies with y…
SMSKeywordRuleScope
string
Whether the rule is one of Bird's defaults (system) or one your workspace created (workspace). A workspace rule takes precedence over Bird's default for the sa…
SMSKeywordRuleID
string
Identifier of a keyword rule. An sks id is one of Bird's defaults, which you can read but not change; an skw id is a rule your workspace created.
SMSKeywordRule
object
14 properties
8 required
SMSKeywordRuleList
object
1 property
1 required
SMSKeywordRuleCreate
object
7 properties
1 required
SMSKeywordRuleUpdate
object
Changes the reply and the added keywords. What a rule applies to (its operation, country, language and number) is fixed once created: those decide which inboun…
3 properties
TCRBrandStatus
string
The registration status of the brand. A newly created brand is pending; approved and rejected reflect the registration outcome.
TCRBrandID
string
TCRBrandSubmissionID
string
TCRSubmissionStatus
string
The outcome of a single submission attempt, for either a 10DLC brand or a campaign. An attempt is submitted while the registration it belongs to is pending; ap…
TCRSubmissionRejectionReason
object
One reason a 10DLC submission attempt was rejected. The campaign registry reports a list of these, so a single rejection can name several problems at once, eac…
3 properties
1 required
TCREntityType
string
The legal-entity classification of the brand. This determines which other fields are required. Sole proprietors must supply contactfirstname, contactlastname,…
TCRStockExchange
string
The stock exchange the brand is listed on. Required for publicly-traded companies.
TCRVertical
string
The industry vertical the brand operates in.
TCRAltBusinessIDType
string
The scheme of the alternative business identifier supplied in altbusinessid: - none: No alternative business identifier is supplied. - duns: A D-U-N-S Number,…
TCRBrandSubmission
One attempt to register a 10DLC brand's details. The submitted business details are fixed at creation. Resubmit a rejected brand as a new attempt instead of ed…
TCRBrand
A 10DLC brand registration. The business details are carried by its submissions: currentsubmission embeds the latest attempt.
TCRBrandList
TCRBrandCreate
object
A 10DLC brand to register. Which of the optional fields are required depends on businessentitytype (see its description). Some fields must be omitted for the w…
24 properties
11 required
TCRBrandPrecheckRequest
object
The brand details to evaluate. Every field is optional. The prediction treats missing fields as risk factors rather than errors, so an in-progress form can sti…
22 properties
TCRRiskFlag
object
A specific issue in the brand details that could delay or reject registration.
5 properties
5 required
ComplianceDataType
string
The kind of value a requirement takes. The string value is a single line, while text runs to several. The enum value accepts only the values listed with the re…
ComplianceRequirementFieldOption
object
2 properties
2 required
ComplianceFieldValidation
object
Constraints a value must satisfy, where the requirement sets any. Which of these apply follows from its data type: pattern, minlength and maxlength constrain s…
5 properties
AttachmentID
string
ComplianceItemState
string
Where one requirement stands. The notsupplied state means nothing has been given for it yet. The supplied state means we have your answer and review has not st…
ComplianceRequirementField
object
21 properties
21 required
TCRBrandRequirements
object
What a 10DLC brand needs before the campaign registry will accept it, in the order to present it, plus what you have already supplied and where each item stand…
5 properties
4 required
TCRCampaignStatus
string
The registration status of the campaign. A newly created campaign is pending; approved and rejected reflect the registration outcome. An approved campaign late…
TCRCampaignID
string
TCRCampaignSubmissionID
string
TCRCampaignUseCase
string
The messaging use case the campaign runs. mixed and lowvolume are umbrella use cases that require a set of sub-use-cases drawn from this same list. m2m is mach…
AttachmentStatus
string
Lifecycle of an attachment. draft is a file that has been uploaded but nothing has been registered or submitted with it yet, and it is discarded at its expires…
Attachment
A supporting document uploaded for an SMS registration (10DLC campaign evidence, toll-free verification opt-in screenshots). Reference it from the registration…
TCRCampaignSubmission
One attempt to register a 10DLC campaign's details. The submitted details are fixed at creation. Resubmit a rejected campaign as a new attempt instead of editi…
TCRCampaign
TCRCampaignList
TCRCampaignFields
object
15 properties
4 required
TCRCampaignCreate
A 10DLC campaign to register under a brand. When usecasecategory is mixed or lowvolume, subusecases must list two to five sub-use-cases. Two message samples ar…
TCRCampaignPrecheckRequest
object
The campaign details to evaluate. Every field is optional. The prediction treats missing fields as risk factors rather than errors, so an in-progress form can…
20 properties
TCRCampaignRequirements
object
What a 10DLC campaign registration needs before the campaign registry will accept it, in the order to present it, plus what you have already supplied and where…
5 properties
4 required
TCRCampaignNumberLinkStatus
string
Where a number stands on its campaign. - pending: Recorded, waiting on the campaign's approval or the carriers' confirmation. The number cannot send to the US…
TCRCampaignNumberLinkID
string
SMSSenderID
string
TCRCampaignNumberLink
TCRCampaignNumberLinkList
TCRCampaignNumberLinkCreate
object
1 property
1 required
TCRCampaignNumberLinkAssignResult
object
1 property
1 required
TCRCampaignSubmissionList
TCRCampaignSubmissionCreate
The details to register for a 10DLC campaign, submitted as a new attempt. They replace what the previous attempt submitted. Five fields are fixed once a campai…
ComplianceIdentityAnswer
object
One business detail this party last submitted, when it was filed, and where review has got to on it.
2 properties
2 required
ComplianceIdentity
object
A party you register on behalf of: your own business, or one of your clients. Reusing an identity across registrations is what stops you retyping the same busi…
5 properties
5 required
ComplianceIdentityList
ComplianceIdentityCreate
object
1 property
1 required
ValidationError
Field validation error. Uses the standard error envelope with type set to validationerror and details always present.
ComplianceIdentityUpdate
object
Renames the party. Its business details are not editable here; they are filled in by the reviews your registrations pass.
1 property
1 required
AttachmentList
AttachmentUpload
object
The file to upload, sent as a multipart/form-data body.
2 properties
1 required
AssetKind
string
The category a media-library asset's type falls into. Use it to group or filter a mixed library. It also helps you present an asset your interface cannot previ…
AssetFolderID
string
AssetID
string
Asset
A file in the workspace's media library, hosted at a permanent public URL. Embed or link url anywhere hosted media is needed, including in email that has alrea…
AssetList
AssetUpload
object
The file to upload, sent as a multipart/form-data body.
4 properties
1 required
AssetUpdate
object
Fields to change on an asset. Omit a field to leave it as it is. The asset's bytes and URL are fixed and cannot be changed.
3 properties
AssetReferenceUsage
string
Which copy of a resource uses an asset. - draft: it is not reaching anyone yet. - published: the change has to be published before recipients see it. - both: t…
AssetReference
object
A resource that uses an asset, so you can find everything to update before replacing an image.
4 properties
4 required
AssetReferenceList
object
2 properties
2 required
AssetFolder
A folder in the workspace's media library. Folders organize assets for the people browsing them and never appear in an asset's URL, so moving an asset between…
AssetFolderList
AssetFolderCreate
object
The folder to create.
2 properties
1 required
AssetFolderUpdate
object
Fields to change on a folder. Omit a field to leave it as it is. Renaming a folder or moving it changes nothing about the assets inside it, including their URL…
2 properties
ComplianceSubjectKind
string
What is being registered. - smssender: a sender registered to send to one country. - number: a phone number you hold that needs ownership paperwork before it c…
ComplianceSubjectID
string
What is being registered. For smssender this is the scr id returned when you register a sender for a country. For number it is the nda id of a dedicated number…
ComplianceProgram
string
The registration program a country runs. Available programs depend on the registered resource. An SMS sender registers under an authority regime (alpha or nume…
ComplianceSubmissionID
string
ComplianceObligationReason
string
Why a registration that is already authorised has been asked for something more. - policychange means the country published a newer version of its form and you…
ComplianceObligationState
string
Where an obligation stands. - open: the due date has not passed and nothing has been supplied. - satisfied: you supplied what was asked. - lapsed: the date pas…
ComplianceObligation
object
4 properties
4 required
ComplianceGeneralReasons
array
Feedback about the submission as a whole from an external verifier. It can remain visible while corrections are under review. Empty when no unresolved verifier…
ComplianceRequirement
object
13 properties
12 required
ComplianceSubmissionIdentity
object
Registers this on behalf of a party you have not stored yet, creating it as part of the submission so you do not need a separate call. Exclusive with identityi…
1 property
ComplianceAnswer
object
One answer. Which field carries it follows from the requirement, as the requirements read reports it: - answered once, inline: value - answered once, with a do…
5 properties
1 required
ComplianceSubmissionCreate
object
7 properties
5 required
ComplianceItemID
string
ComplianceSubmissionItem
object
11 properties
11 required
ComplianceSubmission
object
11 properties
10 required
ComplianceSubmissionResupply
object
Replacement answers for an existing submission. Rejected, expired, or missing answers can be supplied again; accepted answers normally cannot be changed. When…
1 property
1 required
TCRBrandSubmissionList
TCRBrandVettingID
string
TCRVettingClass
string
Which external vetting product to order for a 10DLC brand. The authplus class is required for publicprofit brands before creating any campaign under them, and…
TCRVettingStatus
string
The status of one vetting attempt. The pending status means the provider is still reviewing. For authplus, the business contact has not yet confirmed the verif…
TCRBrandVetting
One attempt to order external vetting for a 10DLC brand.
TCRBrandVettingList
object
1 property
1 required
TCRBrandVettingRequest
object
Order external vetting for a 10DLC brand.
1 property
1 required
StatsComparePeriod
string
Set to previousperiod to also return the same figures for the immediately preceding window of equal length, plus the change between the two, so you can show "+…
SMSStatsSummaryPeriod
object
The window the server actually computed against. The summary serves two window grains: calendar days (bounds are YYYY-MM-DD) and hours (bounds are RFC 3339 ins…
3 properties
2 required
SMSDeliveryStats
object
SMS lifecycle counts and rates for a whole period or breakdown. Counts use the message send time, so a later delivery stays attributed to the bucket in which t…
9 properties
9 required
SMSLatencyQuantiles
object
Approximate p50, p95, and p99 latency percentiles in milliseconds for one latency family. All three are null when no qualifying event contributed a measurement.
3 properties
3 required
SMSLatencyStats
object
Latency percentiles in milliseconds for the requested scope: - processing: From acceptance to carrier handoff. - delivery: From carrier handoff to delivery con…
3 properties
SMSStatsComparisonDelta
object
Changes from the previous period. A pctchange value is the signed relative change (current - previous) / previous and is null when the previous count is zero.…
9 properties
9 required
SMSStatsComparison
object
The same statistics for the equal-length, inclusive period ending immediately before the requested start, together with the change between the two periods. Pre…
4 properties
4 required
SMSStatsSummary
object
Single-row aggregate across the full requested period, covering SMS lifecycle counts plus the derived delivery and failure rates, and latency percentiles. Use…
4 properties
3 required
StatsGrain
string
The bucket grain of the series, either day or hour.
SMSStatsSeriesPeriod
object
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
4 properties
3 required
SMSDeliveryCounts
object
SMS lifecycle counts for a time bucket. Counts use the message send time, so a message accepted on Monday and delivered on Tuesday counts in Monday's bucket. R…
7 properties
7 required
SMSStatsPoint
object
SMS lifecycle counts for one time bucket (a calendar day or hour), bucketed by send time. Every count in a bucket describes the messages accepted in it, regard…
2 properties
2 required
SMSStatsResponse
object
Time-series stats payload. period echoes the range and bucket grain the server computed against; data is one row per bucket in chronological order.
2 properties
2 required
SMSStatsSortMetric
string
Metric to rank breakdown rows by, applied descending. Shared by the volume breakdowns whose rows carry the full delivery and latency block (originators, countr…
StatsTrendGrain
string
Bucket grain for a stats trend series.
SMSOriginatorStatsPoint
object
Aggregate delivery and latency stats for a single originator (the sender address messages were sent from) over the requested period.
4 properties
3 required
SMSStatsByOriginatorResponse
object
Per-originator breakdown for the requested period, ranked by the sort metric (default accepted) descending and capped at the requested limit (default 50, max 2…
3 properties
3 required
SMSCountryStatsPoint
object
Aggregate delivery and latency stats for a single destination country over the requested period.
4 properties
3 required
SMSStatsByCountryResponse
object
Per-country breakdown for the requested period, ranked by the sort metric (default accepted) descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
SMSCategoryStatsPoint
object
Aggregate delivery and latency stats for a single message category over the requested period.
4 properties
3 required
SMSStatsByCategoryResponse
object
Per-category breakdown for the requested period, ranked by the sort metric (default accepted) descending and capped at the requested limit (default 50, max 200…
3 properties
3 required
SMSStatsLifecycleSortMetric
string
Metric to rank breakdown rows by, applied descending. Shared by the breakdowns whose rows carry lifecycle counts only, with no derived rates to sort on.
SMSErrorCodeStatsPoint
object
Delivery and latency statistics for one standardized failure reason over the requested period.
4 properties
3 required
SMSStatsByErrorCodeResponse
object
Per-error-code breakdown for the requested period, ranked by the sort metric (default failed) descending and capped at the requested limit (default 50, max 200…
3 properties
3 required
SMSCarrierStatsPoint
object
Aggregate delivery and latency stats for a single delivery carrier over the requested period.
4 properties
3 required
SMSStatsByCarrierResponse
object
Per-carrier breakdown for the requested period, ranked by the sort metric (default accepted) descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
SMSTagStatsPoint
object
Aggregate delivery and latency stats for a single tag (name:value) over the requested period.
4 properties
3 required
SMSStatsByTagResponse
object
Per-tag breakdown for the requested period, ranked by the sort metric (default accepted) descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
SMSStatusStatsPoint
object
The number of messages that ended the requested period in a single lifecycle status. This transposes the lifecycle counts into one row per status, so it carrie…
2 properties
2 required
SMSStatsByStatusResponse
object
Lifecycle-status breakdown for the requested period, ordered by message count descending. Statuses with no activity are omitted.
3 properties
3 required
SMSInboundStatsComparisonDelta
object
The change from the preceding period to the requested one. The receivedpctchange field is a signed relative change, computed as (current - previous) / previous…
1 property
1 required
SMSInboundStatsComparison
object
The received-message count for the equal-length, inclusive period ending immediately before the requested start, together with the change between the two perio…
3 properties
3 required
SMSInboundStatsSummaryResponse
object
Total received messages over the requested period.
3 properties
2 required
SMSInboundStatsPoint
object
One time bucket of received-message counts, attributed by arrival time.
2 properties
2 required
SMSInboundStatsResponse
object
Received-message time series. period echoes the range and bucket grain the server computed against; data is one row per bucket in chronological order.
2 properties
2 required
SMSInboundCountryStatsPoint
object
Received-message volume for one country.
2 properties
2 required
SMSInboundStatsByCountryResponse
object
Received-message volume broken down by country, ranked by volume.
3 properties
3 required
SMSInboundOperatorStatsPoint
object
Received-message volume for one mobile operator.
2 properties
2 required
SMSInboundStatsByOperatorResponse
object
Received-message volume broken down by operator, ranked by volume.
3 properties
3 required
SMSInboundNumberStatsPoint
object
Received-message volume for one of your numbers.
2 properties
2 required
SMSInboundStatsByNumberResponse
object
Received-message volume broken down by number, ranked by volume.
3 properties
3 required
DestinationSuperRegion
stringnull
The continent-scale group the region rolls up into. Derived from region, and null whenever that is. Treat the set as open.
SMSDestinationStatus
string
Whether we deliver SMS to this country, independent of your enabled setting. - available: we deliver SMS to this country. - registrationrequired: deprecated; u…
SMSDestination
object
10 properties
5 required
SMSDestinationList
object
2 properties
2 required
DestinationSetting
object
2 properties
2 required
SMSDestinationsUpdate
object
1 property
1 required
SMSSenderSourceKind
string
What backs an SMS sender: a dedicated number, a shared shortcode, or an alphanumeric sender string.
AllocatedNumberID
string
Identifier of a number allocated to your workspace, as returned in the id field of GET /v1/numbers.
SMSSenderType
string
The kind of sender identity a message was sent from: a standard long-code number, a short code, an alphanumeric sender ID, or a toll-free number. Toll-free is…
SMSSenderStatus
string
Where a sender stands on its own setup: the ownership paperwork its number owes, and the registrations it holds. - active: nothing this sender holds is outstan…
SMSSenderDestinations
object
Where this sender stands with the destinations it is set up for, grouped by whose move is next. These are not every country the sender could reach. pending and…
3 properties
3 required
SMSSender
object
11 properties
7 required
SMSSenderList
SMSSenderCreate
object
2 properties
2 required
SMSRegistrationStatus
string
Country-registration lifecycle state: - pending: Registration work has started. - underreview: Everything this country requires has been submitted and is being…
SMSCountryRegistrationID
string
SMSSenderProgramEntry
string
The resource this country's walk continues at. none means the first one is still to be created; every other value names what to read next, whose id is programe…
SMSSenderRequirement
object
16 properties
6 required
SMSSenderProgram
object
4 properties
4 required
SMSSenderRequirementList
object
2 properties
2 required
SMSCountryRegistrationCreate
object
2 properties
1 required
SMSCountryRegistration
object
9 properties
5 required
TFNVerificationStatus
string
Lifecycle state of a toll-free number verification: - draft: You can edit or submit the business and messaging details. - submitted: The verification was sent…
TFNVerificationID
string
TFNBusinessRegistrationType
string
Kind of government-issued business registration identifier supplied in businessregistrationnumber for a toll-free verification: - ein: US Employer Identificati…
TFNEntityType
string
Legal structure of the business being verified. Spelled the same as 10DLC's entity type, which names the same five structures; the two stay separate enums beca…
TFNMessageVolume
string
Estimated messages a month, as the band the carrier reviews against. One band per value the carrier accepts, so nothing is lost in either direction. The top ba…
TFNVerificationBase
object
The server-owned fields returned on every toll-free verification.
41 properties
9 required
TFNVerification
A workspace's toll-free number verification containing the business and messaging details submitted to license a toll-free number for sending in the United Sta…
TFNVerificationList
TFNVerificationInput
object
The writable business and messaging dossier shared by the create and update bodies of a toll-free verification.
28 properties
TFNVerificationCreate
Fields for a new toll-free verification. The toll-free sender is required and cannot be changed later; every other field is optional. Fill in the dossier over…
TFNVerificationRequirements
object
What a toll-free verification needs before a carrier will review it, in the order to present it, plus what you have already supplied and where each item stands.
5 properties
4 required
TFNVerificationUpdate
Fields to update on an editable toll-free verification. Verifications in draft or inforequested are editable. A rejected verification is editable while resubmi…
LookupProperty
string
An intelligence property you can add to a base phone number lookup. - classification: the property resolves linetype to its precise allocated service (premium…
PhoneNumberLookupRequest
object
2 properties
1 required
LookupNetworkInfo
object
The network a number belongs to.
3 properties
LookupFlag
string
A notable characteristic of a number. ported means the number has moved from the network that issued it to another one, so networkinfo and originalnetworkinfo…
LookupLineType
string
What kind of line the number is, as reported by the carrier platform. This is included in every base lookup, regardless of which properties you request. - unkn…
LookupPropertyStatus
string
How a requested property resolved. - ok: the property was answered and its value is in the response. - unavailable: no answer arrived, so the property adds not…
LookupClassificationValue
string
The allocated service of the number's range, at the precision the intelligence source publishes it. This is a finer vocabulary than linetype, which reports wha…
LookupClassification
object
The allocated service of the number's range. Returned when you request the classification property. This sits beside linetype rather than replacing it, so you…
2 properties
1 required
LookupPresence
object
Whether the number is live on its network right now. Returned when you request the presence property. The result reflects a real-time query to the network wher…
2 properties
1 required
LookupRoaming
object
Whether the number is roaming, and on which network. Returned when you request the roaming property.
4 properties
1 required
LookupSimSwap
object
When the number's SIM last changed. Returned when you request the simswap property.
4 properties
1 required
LookupPortingEvent
object
One recorded move of a number between networks.
2 properties
2 required
LookupPorting
object
Whether the number has ever moved network, when it last did, and its full porting record. Returned when you request the porting property. The base lookup only…
5 properties
1 required
LookupScore
object
A credibility score for the number. Returned when you request the score property.
2 properties
1 required
PhoneNumberLookup
object
Information about a phone number. The number, its flags, and its line type are included in the base lookup and are always present. The country and two networks…
12 properties
3 required
EmailLookupRequest
object
1 property
1 required
EmailLookupResult
string
The verdict on the address, and the one field to decide on. - valid: the address exists and accepts mail. - neutral: it could not be confirmed either way, usua…
EmailLookupFlag
string
A notable characteristic of an email address. - role: it addresses a function rather than a person (support@, info@). Replies and consent are therefore ambiguo…
EmailLookupReason
string
Why an address cannot receive mail. - invalidsyntax: the address is malformed. - invaliddomain: the domain does not accept mail. - invalidrecipient: the domain…
EmailLookup
object
Assessment of whether an email address accepts mail, the confidence and reason for that assessment, and a suggested correction when the address appears misspel…
7 properties
5 required
KycAddress
object
The address you believe the number's owner lives at. Send whichever parts you hold; each is checked on its own, so a partial address still returns an answer fo…
7 properties
KycIdentity
object
What you believe about the person who holds the number. Send only the attributes you want checked. Each is compared independently, and an omitted attribute is…
6 properties
KycMatchRequest
object
2 properties
2 required
KycMatchResult
string
Whether one attribute matched the operator's record. - true: a full match. - false: a match the operator rejected, and it carries a score saying how close it w…
KycAttributeMatch
object
How one attribute you sent compared with the operator's record.
2 properties
1 required
KycAddressMatch
object
How the address you sent compared with the operator's record. Operators differ in how finely they answer. Most compare each part separately and you get streetn…
8 properties
KycIdentityMatch
object
One block per attribute you sent, and nothing for attributes you did not. An attribute you sent that the operator cannot answer about comes back as notavailabl…
7 properties
KycMatch
object
How the identity you sent compares with what the number's mobile operator holds on file for its subscriber. Read each attribute independently. The response has…
2 properties
2 required
VerificationChannel
string
The channel a passcode is delivered over. Open enum: new channels may be added over time, so treat any unrecognized value as a future channel rather than an er…
VerificationID
string
VerificationTerminalReason
string
Why a verification session reached its final state without succeeding: attemptsexhausted (too many incorrect passcodes), ttlelapsed (the time window elapsed be…
VerificationTo
object
The recipient to verify. Provide an email, a phonenumber, or both; at least one is required. The addresses also identify the verification: a check must supply…
2 properties
VerificationChannelEntry
object
1 property
1 required
Money
object
2 properties
2 required
VerificationAttemptFailureReason
string
Why a passcode send did not deliver: - carrierrejected: The SMS carrier rejected the send. - hardbounce: The email permanently bounced. - softbounce: The email…
VerificationAttemptSenderClass
string
How the sender was provisioned. Open enum: treat any unrecognized value as a future class. For email: shared (the shared sender) or customdomain; for SMS: syst…
WhatsAppTemplateCategory
string
Meta's content classification for a template. - authentication: delivers one-time passcodes. - utility: delivers transaction-triggered updates (receipts, order…
VerificationAttempt
object
17 properties
4 required
Verification
VerificationList
VerificationOptions
object
Per-request overrides applied to this verification only.
3 properties
VerificationCreateRequest
object
3 properties
1 required
VerificationCheckRequest
object
2 properties
2 required
VerificationCheckResult
object
4 properties
2 required
VerificationNextChannelRequest
object
1 property
1 required
VerificationResolvedSettings
object
The passcode policy currently in effect for a verification.
5 properties
5 required
VerificationCountryChannel
object
A channel available for this country, in attempt order.
3 properties
2 required
VerificationDefaultsCountry
object
The default delivery plan for one country, before any of your changes.
2 properties
2 required
VerificationDefaults
object
3 properties
3 required
VerificationConfigurationID
string
VerifySharedSender
string
A Bird-managed shared sender identity. The choice decides what each channel sends as: the email from-address, the SMS sender ID, and the WhatsApp business numb…
DomainID
string
VerificationEmailSenderForm
object
The two forms an email sender can take, shared by every tier that stores or reports one. Name a Bird-managed identity in sharedsender and nothing else, or give…
3 properties
VerificationResolvedEmailSender
The email sender identity in effect. sharedsender names the Bird-managed identity when one applies, and the custom-sender fields are then absent; domain and lo…
VerificationSharedSenderPin
object
The sender choice for a channel that offers Bird-managed identities only: name the shared sender the channel sends as.
1 property
1 required
VerificationResolvedSenders
object
The sender identity in effect for each channel that carries one. Each reports whether it uses a Bird-managed shared sender or one you configured. Two channels…
3 properties
3 required
VerificationConfigurationSettings
object
Overrides for the verification passcode policy. Every field is optional; a field you do not set inherits the platform default.
5 properties
VerificationConfigurationOverrides
object
Exactly what this configuration overrides. A field absent here follows the platform default, including future changes to it; a field present is pinned to your…
1 property
1 required
VerificationConfiguration
VerificationConfigurationList
VerificationEmailSender
The sending identity for verification emails, in exactly one of two forms: name a Bird-managed shared sender in sharedsender, or compose a from address of your…
VerificationSenders
object
Sender identities used for verification messages, per channel. A channel you do not set uses the default shared sender.
3 properties
VerificationConfigurationCreateRequest
object
Fields for a new verification configuration.
3 properties
1 required
VerificationConfigurationSettingsUpdate
object
Changes to the passcode policy. A field you omit is left as it is; a field you set to null returns to the platform default; a value pins that field.
5 properties
VerificationSendersUpdate
object
Changes to the default senders. A channel you omit is left as it is; a channel you set to null returns to the default shared sender.
3 properties
VerificationConfigurationUpdateRequest
object
Fields to update. A field you omit is left unchanged. Inside settings and senders, setting a field to null returns it to the platform default. A value pins the…
4 properties
VerificationCountrySenderChoice
The email sender choice stored for this country: either a Bird-managed shared sender, or a sender of your own.
VerificationCountryPlanSenders
object
This country's stored sender choices, verbatim: per channel, either a Bird-managed shared sender or your own. A channel absent here inherits the configuration'…
3 properties
VerificationCountryPlan
object
The delivery plan in effect for one country, whether it comes from your settings or the default.
6 properties
5 required
VerificationCountryPlanList
object
2 properties
2 required
VerificationCountryChannelUpdate
objectnull
Whether to use this channel for this country, or null to return it to the default.
1 property
1 required
VerificationCountryChannelsUpdate
object
Per-channel settings, keyed by channel. A channel you omit is left unchanged; set a channel to null to return it to the default.
5 properties
VerificationCountryEmailSenderUpdate
The email sender choice for one country. Name a Bird-managed identity in sharedsender with no other fields, or provide your own domain and localpart. Set the e…
VerificationCountrySendersUpdate
object
Sender choices for this country, per channel. For each channel: null inherits your configuration default, a Bird-managed identity named in sharedsender pins th…
3 properties
VerificationCountryUpdateRequest
object
The fields to change for this country. A field you omit is left as it is. Whether the country is on, each channel's on/off, the channel order, and the per-chan…
4 properties
VerifyStatsPeriod
object
The window the server actually computed against, echoed back from the request.
3 properties
2 required
VerifyStatsFunnel
object
Verification-session lifecycle counts and derived rates for the containing row. Counts use distinct verification sessions and are attributed by event time. cre…
6 properties
6 required
VerifyDeliveryStats
object
Passcode send-attempt counts and derived rates for the containing row. Counts use distinct send attempts. sent was handed to the channel, delivered was confirm…
6 properties
6 required
VerifyStatsQuantiles
object
Approximate latency percentiles in milliseconds. Each value is null when no qualifying event contributed a measurement in scope.
3 properties
3 required
VerifyStatsLatency
object
Latency percentiles (p50, p95, p99) in milliseconds, computed across the whole scope. Two families are reported: - timetoverify: Time from a verification sessi…
2 properties
2 required
VerifyStatsCost
object
Average spend per verification session over the scope, in your workspace's billing currency.
1 property
VerifyStatsComparisonDelta
object
Change in each headline metric from the preceding period to the requested period. A pctchange is the signed relative change in a count, computed as (current -…
11 properties
11 required
VerifyStatsComparison
object
The same funnel and delivery statistics for the equal-length period ending immediately before the requested start, together with the change between the two per…
4 properties
4 required
VerifyStatsSummary
object
Single-row aggregate across the full requested period, covering verification funnel counts, delivery counts, latency percentiles, and spend. Use this endpoint…
6 properties
5 required
VerifyStatsSeriesPeriod
object
The window and bucket grain the response covers, echoed back from the request.
4 properties
3 required
VerifyStatsPoint
object
Verification lifecycle counts for one calendar-day or hourly bucket, attributed by event time. Rates, latency, and spend are whole-window aggregates reported b…
7 properties
7 required
VerifyStatsSeries
object
Time-series stats payload. period echoes the range and bucket grain the server computed against; data is one row per bucket in chronological order.
2 properties
2 required
VerifyStatsCountryRowComparisonDelta
object
Change in this country's lifecycle metrics from the preceding period to the requested period. A pctchange is the signed relative change in a count, computed as…
5 properties
5 required
VerifyStatsCountryRowComparison
object
Lifecycle counts and conversion rate for this country over the equal-length period immediately before the requested period, with the change between the two per…
6 properties
6 required
VerifyStatsCountryRow
object
Verification funnel counts for a single destination country over the requested period.
7 properties
6 required
VerifyStatsCountriesResponse
object
Per-country funnel breakdown for the requested period, ranked by createdsessions descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
VerifyStatsChannelRowComparisonDelta
object
The change in this channel's delivery metrics from the preceding period to the requested one. A pctchange is a signed relative change in a count, computed as (…
5 properties
5 required
VerifyStatsChannelRowComparison
object
The same delivery counts and rate for this channel over the equal-length period ending immediately before the requested start, together with the change between…
6 properties
6 required
VerifyStatsChannelRow
object
Delivery and conversion counts for a single passcode delivery channel over the requested period.
9 properties
8 required
VerifyStatsChannelsResponse
object
Per-channel delivery and conversion breakdown for the requested period, ranked by sent descending.
2 properties
2 required
VerifyStatsReasonRow
object
The number of verification sessions that ended in a given terminal reason over the requested period.
2 properties
2 required
VerifyStatsReasonsResponse
object
Session terminal-reason breakdown for the requested period, one row per reason with activity, ordered by session count descending.
2 properties
2 required
VerifyStatsDeliveryChannelRow
object
Delivery counts for a single passcode delivery channel over the requested period.
6 properties
6 required
VerifyStatsDeliveryFailureReasonRow
object
The number of passcode send attempts on a channel that failed for a given reason over the requested period.
3 properties
3 required
VerifyStatsDeliveryResponse
object
Deliverability breakdown for the requested period, covering whole-window delivery counts, a per-channel breakdown, a per-channel failure-reason breakdown, and…
5 properties
5 required
VerifyStatsPricingRow
object
The blended cost per passcode send attempt for a single destination country over the requested period.
5 properties
4 required
VerifyStatsPricingResponse
object
Per-country blended cost breakdown for the requested period, ranked by costamount descending and capped at the requested limit (default 50, max 200).
4 properties
3 required
PreviewFeatureCheck
object
1 property
1 required
PreviewOrgID
string
AdminPreviewOrg
object
4 properties
4 required
AdminPreviewOrgList
object
1 property
1 required
AdminPreviewOrgCreate
object
1 property
1 required
PreviewFeatureRegistryID
string
AdminPreviewFeatureRegistryEntry
object
5 properties
5 required
AdminPreviewFeatureRegistryList
object
1 property
1 required
AdminVerificationConfigSettings
object
Default code settings every workspace inherits unless it overrides them.
7 properties
7 required
AdminVerificationChannelsList
array
An ordered list of verification channel names. Open enum — new channels may be added over time, so treat any unrecognized value as a future channel.
AdminVerificationConfig
AdminVerificationConfigList
object
1 property
1 required
AdminVerificationConfigSettingsUpdate
object
Code settings to change. Omit a field to leave it unchanged.
7 properties
AdminVerificationConfigUpdate
object
Fields to change on the admin verification config. Omit a field to leave it unchanged.
2 properties
AdminVerificationConfigCountry
AdminVerificationConfigCountryList
object
1 property
1 required
AdminVerificationConfigCountryUpsert
object
3 properties
1 required
VerificationChannelDisableID
string
AdminVerificationChannelDisable
object
10 properties
5 required
AdminVerificationChannelDisableList
object
1 property
1 required
AdminVerificationChannelDisableCreate
object
3 properties
2 required
WhatsAppServiceWindow
object
3 properties
1 required
WhatsAppMessageStatus
string
Delivery status: - accepted: Accepted and queued for sending. - sent: Handed to the WhatsApp network. - delivered: Confirmed as delivered to the recipient's de…
WhatsAppGroupID
string
WhatsAppMessageID
string
WhatsAppAddress
object
Sender or recipient of a WhatsApp message: a phone number, a business-scoped user ID, or both. A message received from a WhatsApp user carries whatever profile…
5 properties
WhatsAppTemplateParameterType
string
The kind of value a template parameter carries, which follows the block it fills. The text type is a plain string substituted into a placeholder. This includes…
WhatsAppLocationSend
object
A free-form location to send: a point on the map the recipient can open in their maps app. Deliverable only inside an open 24-hour customer service window; out…
4 properties
2 required
WhatsAppMessageTemplateComponentParameter
object
5 properties
1 required
WhatsAppMessageTemplateCardComponent
object
The values that fill one block of one carousel card.
2 properties
1 required
WhatsAppMessageTemplateCard
object
The values that fill one card of a carousel. Cards fill in the order the template was approved with, so send one entry per card and keep them in that order.
1 property
1 required
WhatsAppMessageTemplateComponent
object
3 properties
1 required
WhatsAppMessageTemplate
object
The template a message was sent from. On reads slug, language, category, and components are always present; components is an empty array for an authentication…
4 properties
4 required
WhatsAppText
object
Text content of a WhatsApp message.
1 property
1 required
WhatsAppFileID
string
WhatsAppMedia
object
Fields shared by every media content object on a WhatsApp message.
3 properties
WhatsAppImage
object
Image content of a WhatsApp message.
WhatsAppVideo
object
Video content of a WhatsApp message.
WhatsAppAudio
object
Audio content of a WhatsApp message.
WhatsAppSticker
object
Sticker content of a WhatsApp message.
WhatsAppDocument
object
Document content of a WhatsApp message.
WhatsAppLocation
object
Location content of a WhatsApp message: a point on the map the recipient can open in their maps app.
5 properties
WhatsAppContactName
object
The contact's name, in the parts their device supplied. Every part is optional: WhatsApp sends what the card holds and omits the rest.
6 properties
WhatsAppContactOrg
object
Where the contact works, as their card records it.
3 properties
WhatsAppContactPhone
object
One phone number on a shared contact card.
2 properties
WhatsAppContactEmail
object
One email address on a shared contact card.
2 properties
WhatsAppContactUrl
object
One website on a shared contact card.
2 properties
WhatsAppContactAddress
object
One postal address on a shared contact card.
7 properties
WhatsAppContactCard
object
A contact card on this message: one the contact shared, or one this workspace sent. Nothing here is required. WhatsApp sends the parts the card holds and omits…
9 properties
WhatsAppInteractiveType
string
Which kind of interactive message this is. - button: up to three tappable buttons, each sending its own identifier back as an inbound message. Carried in butto…
WhatsAppInteractiveHeaderType
string
A header's kind, and which field carries it. Open enum: WhatsApp adds header kinds over time, so treat an unrecognized value as a future kind rather than an er…
WhatsAppInteractiveHeader
object
What the interactive message showed above its body. type names the kind and the field that carries it: text for a line of copy, url for the file every other ki…
3 properties
1 required
WhatsAppInteractiveButtonType
string
Which kind of button this is, and which field carries it. - quickreply: sends its own identifier back as an inbound message. - ctaurl: opens a link in the reci…
WhatsAppInteractiveQuickReplyButton
object
A reply button's label and the handle it carries back. On the echo of a message Bird sent, the pair the send declared; on an inbound interactivereply, the pair…
2 properties
2 required
WhatsAppInteractiveCtaUrl
object
The link button the message offered: its label and the address it opens.
2 properties
2 required
WhatsAppInteractiveButton
object
One button the message offered. The field named by type is the one that is present. As on the message itself, the read vocabulary is open: dispatch on type and…
3 properties
1 required
WhatsAppInteractiveListRow
object
One option in a list's menu. On the echo of a message Bird sent, the row as declared; on an inbound interactivereply, the row the contact chose. No length is d…
3 properties
2 required
WhatsAppInteractiveListSection
object
One group of options in the menu the message showed.
2 properties
2 required
WhatsAppInteractiveList
object
The menu the message offered: a button that opens it, and the groups of options behind it.
2 properties
2 required
WhatsAppInteractiveCard
object
One card the carousel showed, in the position it appeared in.
3 properties
2 required
WhatsAppInteractive
object
Interactive content of a WhatsApp message: body text plus something the recipient can tap. The field named by type is the one that is present, except on locati…
8 properties
2 required
WhatsAppInteractiveReplyType
string
Which kind of tap the reply came from. - button: a reply button on an interactive message, or a quick-reply button on a template. Both carry an identifier and…
WhatsAppInteractiveReply
object
What the contact tapped, on an inbound message answering an interactive message or a template's quick-reply button. type names the kind and the field it names…
3 properties
1 required
WhatsAppUnsupported
object
A message whose content we do not model, named so it is visible in the message log rather than arriving empty. Inbound only.
1 property
1 required
WhatsAppReaction
object
An emoji reaction standing on a message. One entry per sender: reacting again replaces that sender's entry rather than adding one, and removing a reaction drop…
2 properties
2 required
WhatsAppAgentController
string
Who is answering a contact's conversation right now. - agent means the agent holds it and replies to the contact. - app means your own application holds it, an…
WhatsAppErrorCode
string
Standardized failure reason: - insufficientbalance: The workspace wallet could not fund the send. - pricenotfound: No price was configured for the destination…
WhatsAppError
objectnull
Failure detail for a message that could not be delivered or was rejected.
4 properties
3 required
WhatsAppMessage
object
30 properties
6 required
WhatsAppMessageList
WhatsAppTemplateID
string
WhatsAppTemplateSend
object
A send-by-template reference. Identify the template by its id or its slug (supply exactly one), optionally name a language, and fill its placeholders through c…
4 properties
WhatsAppTextSend
object
Free-form text to send. Deliverable only inside an open 24-hour customer service window; outside one, send a template instead.
2 properties
1 required
WhatsAppImageSend
object
A free-form image to send, with an optional caption. Deliverable only inside an open 24-hour customer service window; outside one, send a template instead.
2 properties
1 required
WhatsAppVideoSend
object
A free-form video to send, with an optional caption. Deliverable only inside an open 24-hour customer service window; outside one, send a template instead.
2 properties
1 required
WhatsAppAudioSend
object
Free-form audio to send, either as a voice note or as a basic audio file. Deliverable only inside an open 24-hour customer service window; outside one, send a…
2 properties
1 required
WhatsAppStickerSend
object
A free-form sticker to send. Deliverable only inside an open 24-hour customer service window; outside one, send a template instead.
1 property
1 required
WhatsAppDocumentSend
object
A free-form document to send, with an optional caption and filename. Deliverable only inside an open 24-hour customer service window; outside one, send a templ…
3 properties
1 required
WhatsAppInteractiveTypeWrite
string
Which kind of interactive message to send. - button: up to three tappable buttons, each sending its own identifier back as an inbound message. Carried in butto…
WhatsAppInteractiveHeaderTypeWrite
string
A header's kind, and which field carries it. text is a line of copy; the rest each show a file whose address you give in url. A list accepts text only, and a c…
WhatsAppInteractiveHeaderSend
object
What to show above an interactive message's body. type names the kind and the field that carries it: text for a line of copy, url for the file every other kind…
3 properties
1 required
WhatsAppInteractiveButtonTypeWrite
string
Which kind of button this is, and which field carries it. - quickreply: sends its own identifier back as an inbound message. The name WhatsAppTemplateButtonTyp…
WhatsAppInteractiveQuickReplyButtonSend
object
One tappable reply button. Tapping it sends slug back as an inbound message, which reads as an interactivereply.
2 properties
2 required
WhatsAppInteractiveCtaUrlSend
object
A button that opens a link in the recipient's browser, so a long or opaque address never has to appear in the message body.
2 properties
2 required
WhatsAppInteractiveButtonSend
object
One button on an interactive message or on a carousel card. type names the kind and the field that carries it, so a button kind WhatsApp adds later arrives as…
3 properties
1 required
WhatsAppInteractiveListRowSend
object
One option in a list's menu. Choosing it sends slug back as an inbound message, which reads as an interactivereply.
3 properties
2 required
WhatsAppInteractiveListSectionSend
object
One group of options in a list's menu. A menu with a single group still carries a title, which WhatsApp shows above its rows.
2 properties
2 required
WhatsAppInteractiveListSend
object
A menu of options behind a single button. The recipient taps the button, WhatsApp opens the menu, and choosing one option sends it back as a reply.
2 properties
2 required
WhatsAppInteractiveCardHeaderSend
object
The media at the top of a carousel card. Every card must carry one, and it must be an image or a video: a card takes no text or document header.
2 properties
2 required
WhatsAppInteractiveCardSend
object
One card in a carousel: media at the top, optional text of its own, and the buttons under it. A card has no footer, and its position in cards is the position i…
3 properties
2 required
WhatsAppInteractiveSend
object
An interactive message to send: body text plus something for the recipient to tap. Name the kind in type and carry that kind's field alongside it: buttons, lis…
8 properties
2 required
WhatsAppContactNameSend
object
The contact's name. formattedname is what the card shows, and WhatsApp additionally requires at least one of the parts below it, so a card carrying only a form…
6 properties
1 required
WhatsAppContactOrgSend
object
Where the contact works, as the card should record it.
3 properties
WhatsAppContactPhoneSend
object
One phone number to put on a contact card.
2 properties
1 required
WhatsAppContactEmailSend
object
One email address to put on a contact card.
2 properties
1 required
WhatsAppContactUrlSend
object
One website to put on a contact card.
2 properties
1 required
WhatsAppContactAddressSend
object
One postal address to put on a contact card.
7 properties
WhatsAppContactCardSend
object
A contact card to send. WhatsApp shows the name on the card and the rest in a profile view the recipient opens from it. A card carrying a phone number renders…
7 properties
1 required
WhatsAppMessageSendRequest
object
A WhatsApp message to send. Carry exactly one kind of content: a request with none returns a 422 WhatsAppContentRequired, and one carrying more than one return…
15 properties
1 required
WhatsAppReadReceiptRequest
object
What to acknowledge on the inbound message. An absent body and {} mean the same thing: mark the message read and show nothing.
1 property
WhatsAppReadReceipt
object
The acknowledgement Bird accepted. There is no status to poll afterwards: WhatsApp reports nothing about a read receipt.
1 property
1 required
WhatsAppEventType
string
Message timeline event type: - whatsapp.accepted: The API accepted the request. - whatsapp.sent: The message reached the WhatsApp network. - whatsapp.delivered…
WhatsAppEventID
string
WhatsAppEvent
object
5 properties
3 required
WhatsAppEventList
object
1 property
1 required
WhatsAppReactionUpsert
object
1 property
1 required
WhatsAppReactionEventID
string
WhatsAppReactionAccepted
object
A reaction as accepted, which WhatsApp has not applied yet and may still refuse. It names the reaction-log entry the request created, so a caller that places t…
2 properties
2 required
WhatsAppReactionEventStatus
string
What became of one reaction change: - received means the contact placed or removed the reaction and WhatsApp told us about it. Every inbound entry carries this…
WhatsAppReactionEvent
object
One change to a reaction on a message: a reaction placed, replaced by a different emoji, or taken back. Entries are never edited, so a sender who reacts twice…
6 properties
5 required
WhatsAppReactionEventList
WhatsAppGroupStatus
string
Where the group stands. Values, in lifecycle order: - pending means the request to create the group has been accepted and WhatsApp has not confirmed it yet. Th…
WhatsAppNumberID
string
WhatsAppGroupJoinApprovalMode
string
How someone opening the invite link gets in: - autoapprove means they join the moment they open the link. This is the default when the group is created. - appr…
WhatsAppGroupOperationType
string
What was asked of the thing carrying the operation: - create and delete act on the group itself. - settingsupdate changes the group's subject, description or p…
WhatsAppGroupOperationStatus
string
How the operation ended: - pending means WhatsApp accepted the request and has not reported back. Another operation on the same thing is refused while this las…
WhatsAppGroupOperationField
string
Which of the group's settings a settingsupdate result reports on.
WhatsAppGroupError
object
Why a change to a group did not take effect. Meta documents no code vocabulary for a group refusal, since every sample payload carries an undocumented code bes…
2 properties
1 required
WhatsAppGroupOperationResult
object
What became of one field in a settingsupdate. WhatsApp applies each field separately, so a single update can leave some applied and others refused.
3 properties
2 required
WhatsAppGroupOperation
object
The last change asked of this group or participant, and where it got to. WhatsApp confirms a change on a webhook rather than in its reply, so an operation is p…
6 properties
3 required
WhatsAppGroupParticipant
object
Someone who joined the group. The business number that created the group is its admin and is not listed.
4 properties
1 required
WhatsAppGroupPinnedMessage
object
A message pinned at the top of a group's chat.
2 properties
2 required
WhatsAppGroup
WhatsAppGroupList
WhatsAppGroupCreate
object
The group to create. WhatsApp issues the invite link, and people join by opening it, so a create request names no participants.
4 properties
2 required
WhatsAppGroupUpdate
object
The changes to make. Fields you omit are left as they are. WhatsApp applies each field separately, so one can be rejected while the others take effect; the gro…
3 properties
WhatsAppGroupInviteLink
object
A group's invite link.
1 property
1 required
WhatsAppGroupPinnedMessageCreate
object
A message to pin at the top of the group's chat.
2 properties
1 required
WhatsAppGroupJoinRequestID
string
WhatsAppGroupJoinRequest
object
Someone waiting to be let into a group that requires approval.
5 properties
3 required
WhatsAppGroupJoinRequestList
WhatsAppGroupJoinRequestDecision
object
The join requests to decide on.
1 property
1 required
WhatsAppGroupJoinRequestFailure
object
A join request the decision could not be applied to.
2 properties
2 required
WhatsAppGroupJoinRequestDecisionResult
object
What happened to each join request in the batch. WhatsApp decides them one by one, so a batch can be part-applied: the requests it accepted are in decided, and…
2 properties
2 required
WhatsAppTemplateExampleParameter
object
4 properties
1 required
WhatsAppTemplateButton
object
6 properties
1 required
WhatsAppTemplateCardComponent
object
One content block inside a carousel card.
5 properties
1 required
WhatsAppTemplateCard
object
One card in a carousel.
1 property
1 required
WhatsAppTemplateComponent
object
8 properties
1 required
WhatsAppTemplatePreview
object
2 properties
2 required
WhatsAppTemplateLanguageStatus
string
Language review and health status: - approved: Passed review and can be sent. - pending: Under review. - rejected: Failed review. - paused or disabled: Sending…
WhatsAppTemplateRejectionCategory
string
Why Meta refused a language's content, in Meta's own vocabulary, lowercased. Read it with reason, which carries Meta's human-written detail, and recommendation…
WhatsAppTemplateRejection
object
Why Meta refused a language's content, and what it says about fixing it. Present when status is rejected.
3 properties
WhatsAppTemplateSubmissionError
object
Why the submission itself did not complete. Distinct from rejection, which is Meta refusing the content it was given.
2 properties
1 required
WhatsAppTemplateLanguageState
object
Where one language stands, without its content: content lives under a version, read that for it. An object rather than a bare status string, so detail beyond s…
5 properties
WhatsAppTemplateVersionID
string
WhatsAppTemplate
object
A message template: one identity holding a copy of the message per language. Each language is reviewed, priced and paused by Meta on its own, so the template's…
21 properties
19 required
WhatsAppTemplateList
WhatsAppTemplateCategoryWrite
string
Meta's content classification for a template. - authentication: delivers one-time passcodes. - utility: delivers transaction-triggered updates (receipts, order…
WhatsAppTemplateComponentTypeWrite
string
A content block's type. A body block is required on every language; header, footer, buttons and carousel are optional and appear at most once each. A carousel…
WhatsAppTemplateHeaderFormatWrite
string
A header's kind. The text format carries a line of copy. The image, video, gif, and document formats each show a file whose address you give in url. A gif is a…
WhatsAppTemplateParameterTypeWrite
string
The kind of value a template parameter accepts. text is an example filling a {{n}} placeholder. The other four are the sample file a media header shows, and ea…
WhatsAppTemplateExampleParameterWrite
object
One example value for one variable, as written to a draft.
4 properties
1 required
WhatsAppTemplateButtonTypeWrite
string
A button's behavior. - url: opens a link. - quickreply: sends its own label back to you as an inbound message. - phonenumber: dials the number it carries. - ot…
WhatsAppTemplateButtonOtpTypeWrite
string
How the recipient receives a one-time passcode. copycode puts it on the clipboard.
WhatsAppTemplateButtonWrite
object
One button, as written to a draft.
6 properties
1 required
WhatsAppTemplateCardComponentTypeWrite
string
A card block's type. A card carries a header showing an image or a video, and optionally a body and a buttons block. A card has no footer and cannot hold a car…
WhatsAppTemplateCardHeaderFormatWrite
string
A card header's kind. A card shows an image or a video only, so a document header works at the top of a template but not on a card.
WhatsAppTemplateCardComponentWrite
object
One content block inside a carousel card, as written to a draft. A card carries a narrower set of blocks than a template does, so it has its own shape rather t…
5 properties
1 required
WhatsAppTemplateCardWrite
object
One card in a carousel, as written to a draft.
1 property
WhatsAppTemplateComponentWrite
object
One content block, as written to a draft. Requests use a separate closed shape because the corresponding response is open. The read shape marks every property…
8 properties
1 required
WhatsAppTemplateRevision
integer
A write counter, incremented every time the content it belongs to changes. It sits at 1 on content that has never been written through this API.
WhatsAppTemplateLanguageUpsert
object
One language's content, as written to a draft.
2 properties
WhatsAppTemplateCreate
object
Parameters for creating a WhatsApp template, optionally seeding its first draft.
9 properties
4 required
WhatsAppTemplateUpdate
object
Partial update of a template's metadata and language policies. Only the fields you send are changed; the rest are left as they stand. The slug can change only…
6 properties
WhatsAppTemplateVersionSummary
object
One version of a template, without its content. A version holds a full copy of every language it was submitted with. Listing versions therefore names the langu…
7 properties
5 required
WhatsAppTemplateVersionList
WhatsAppTemplateVersionLanguage
object
One language's content in one version, and what that submission did with it.
4 properties
1 required
WhatsAppTemplateVersion
object
One version of a template: the content of every language it holds, frozen when it was submitted, alongside what Meta made of each. A draft is a version too: a…
6 properties
5 required
WhatsAppTemplateDuplicate
object
The account the copy is created on, plus optional overrides. Everything else is inherited from the source.
5 properties
1 required
WhatsAppTemplateSubmit
object
Options for a submit. Every field is optional, so an empty body submits the draft as it stands.
1 property
WhatsAppTemplateSubmitProblem
object
One problem found while checking a version.
4 properties
2 required
WhatsAppTemplateSubmitResult
object
The outcome of a submit. The shape is the same whether the submit was a check or a real one: read valid and version to see what happened.
4 properties
2 required
WhatsAppTemplateLanguageSummary
object
One language of a version without its content. Fetch the language itself for the content.
5 properties
3 required
WhatsAppTemplateLanguageList
object
1 property
1 required
WhatsAppTemplateContentHash
string
A hash over the serialized components this API surfaces, prefixed with the algorithm that produced it (sha256:) so the algorithm can change without the field b…
WhatsAppTemplateQualityScore
string
Meta's quality rating for one language of a template, derived from how recipients respond to messages sent from it. The red score is the leading indicator of a…
WhatsAppTemplateQuality
object
Meta's quality rating for one language, with the rating it moved from and when it moved. Present only once Meta has rated the language, and only on the version…
3 properties
2 required
WhatsAppTemplateLanguage
object
One language of one version: its content, what the submission carrying it did with it, and everything Meta holds about it.
14 properties
6 required
WhatsAppTemplateLanguageSaved
object
What a language write returns, enough to make the next write without re-reading.
4 properties
4 required
WhatsAppTemplateLanguageDiscard
object
Parameters for discarding one language's draft edits. Pass revision to guard against overwriting an edit you haven't seen.
1 property
WhatsAppStatsSummaryPeriod
object
The window the server actually computed against. The summary serves two window grains: calendar days (bounds are YYYY-MM-DD) and hours (bounds are RFC 3339 ins…
3 properties
2 required
WhatsAppDeliveryStats
object
WhatsApp lifecycle counts and rates for the requested period, attributed by send time, so a later delivery stays attributed to the period in which its message…
7 properties
7 required
WhatsAppEngagementStats
object
WhatsApp engagement counts and the derived read rate for the scope of the containing row (the whole requested period or a breakdown dimension). The read field…
2 properties
2 required
WhatsAppLatencyQuantiles
object
Approximate p50, p95, and p99 latency percentiles in milliseconds for one latency family. All three are null when no qualifying event contributed a measurement.
3 properties
3 required
WhatsAppLatencyStats
object
Latency percentiles in milliseconds for the requested scope: - processing: From acceptance to WhatsApp handoff. - delivery: From WhatsApp handoff to delivery c…
3 properties
WhatsAppStatsComparisonDelta
object
Changes from the previous period. A pctchange value is the signed relative change (current - previous) / previous and is null when the previous count is zero.…
9 properties
9 required
WhatsAppStatsComparison
object
The same statistics for the equal-length, inclusive period ending immediately before the requested start, together with the change between the two periods. Pre…
5 properties
5 required
WhatsAppStatsSummary
object
WhatsApp lifecycle counts, rates, engagement, and latency percentiles for the full requested period. Counts aggregate the time buckets. Latency percentiles cov…
5 properties
4 required
WhatsAppStatsSeriesPeriod
object
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
4 properties
3 required
WhatsAppDeliveryCounts
object
WhatsApp lifecycle counts for a time bucket, attributed by send time. A message accepted on Monday and delivered on Tuesday counts in Monday's bucket. The sibl…
5 properties
5 required
WhatsAppEngagementCounts
object
WhatsApp engagement counts for a time bucket, attributed by send time. A message accepted on Monday and read on Tuesday counts in Monday's bucket. Read rates a…
1 property
1 required
WhatsAppStatsPoint
object
WhatsApp lifecycle counts, engagement, and latency percentiles for one time bucket (a calendar day or hour), bucketed by send time. Every count in a bucket des…
4 properties
4 required
WhatsAppStatsResponse
object
Time-series stats payload. period echoes the range and bucket grain the server computed against; data is one row per bucket in chronological order.
2 properties
2 required
WhatsAppErrorCodeStatsPoint
object
Number of failed messages for a single normalized failure reason over the requested period.
2 properties
2 required
WhatsAppStatsByErrorCodeResponse
object
Per-error-code failure breakdown for the requested period, ranked by failure count descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
WhatsAppTemplateStatsPoint
object
Lifecycle counts, derived rates, engagement and latency for a single WhatsApp template over the requested period.
4 properties
4 required
WhatsAppStatsByTemplateResponse
object
Per-template breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
WhatsAppTemplateCategoryStatsPoint
object
Lifecycle counts, derived rates, and engagement for a single WhatsApp template category over the requested period.
4 properties
4 required
WhatsAppStatsByTemplateCategoryResponse
object
Per-template-category breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
WhatsAppTagStatsPoint
object
Lifecycle counts, derived rates, and engagement for a single tag (name:value) over the requested period.
4 properties
4 required
WhatsAppStatsByTagResponse
object
Per-tag breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
WhatsAppPhoneNumberStatsPoint
object
Lifecycle counts, rates, and engagement for one business phone number over the requested period, including whether the number is shared.
5 properties
5 required
WhatsAppStatsByPhoneNumberResponse
object
Per-phone-number breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
WhatsAppCountryStatsPoint
object
Lifecycle counts, derived rates, engagement and latency for a single destination country over the requested period.
4 properties
4 required
WhatsAppStatsByCountryResponse
object
Per-country breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
WhatsAppInboundStatsComparisonDelta
object
The change from the preceding period to the requested one. The receivedpctchange field is a signed relative change, computed as (current - previous) / previous…
1 property
1 required
WhatsAppInboundStatsComparison
object
The received-message count for the equal-length, inclusive period ending immediately before the requested start, together with the change between the two perio…
3 properties
3 required
WhatsAppInboundStatsSummaryResponse
object
Total received messages for the requested period.
3 properties
2 required
WhatsAppInboundStatsPoint
object
Received-message count for one time bucket (a calendar day or hour), bucketed by the time each message reached your number.
2 properties
2 required
WhatsAppInboundStatsResponse
object
Received-message time series. period echoes the range the server computed against; data is one row per bucket in chronological order.
2 properties
2 required
WhatsAppInboundPhoneNumberStatsPoint
object
Received-message count for a single business phone number over the requested period.
2 properties
2 required
WhatsAppInboundStatsByPhoneNumberResponse
object
Per-phone-number breakdown of received messages for the requested period, ranked by volume descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
WhatsAppDataLocalizationRegion
string
A country where WhatsApp can store a business phone number's message content at rest, as its two-letter ISO 3166 code.
WhatsAppEmbeddedSignupSubmit
object
6 properties
3 required
WhatsAppNumberStatus
string
Operational state of a business phone number. The preparing status means the service is verifying a managed number. The awaitingsignup status means verificatio…
WhatsAppEmbeddedSignupResult
object
3 properties
3 required
WhatsAppBusinessAccountID
string
WhatsAppNumberSummary
object
The WhatsApp number a resource belongs to, with enough to show it without reading the number back: the same id, phonenumber and name the number list returns.
3 properties
3 required
WhatsAppBusinessAccountSummary
object
The WhatsApp Business Account a resource belongs to, with enough to show it without reading the account back. Read the account itself with GET /v1/whatsapp/bus…
3 properties
3 required
WhatsAppAgentAIAudience
string
Who the agent is allowed to answer on this number. - everyone means the agent answers anyone who writes to the number. - allowlist means it answers only the co…
WhatsAppAgentSummary
object
The agent on a number, reduced to what a list row shows: whether WhatsApp has finished preparing it, whether it is answering, and who it may answer. Read the n…
3 properties
3 required
WhatsAppAgentListItem
object
One WhatsApp number your workspace connected itself, with whether it may run an agent and the agent it runs, if any. A number Bird operates on your behalf cann…
5 properties
4 required
WhatsAppAgentListItemList
WhatsAppNumberScope
string
WhatsAppNumberSortField
string
Sortable fields for a WhatsApp number list.
WhatsAppNumberErrorCode
string
Standardized number-connection failure: - registrationpinrejected: WhatsApp refused the two-step verification PIN. - registrationpinratelimited: Too many PIN a…
WhatsAppNumberError
object
Why a number's connection was refused for good. code is the standardized reason. description explains the failure where one was recorded, and metaerrorcode car…
3 properties
1 required
WhatsAppNumberQualityRating
string
WhatsApp quality rating for a business phone number, based on recipient feedback. green, yellow, and red indicate decreasing quality; sustained red can restric…
WhatsAppNumberMessagingLimit
string
How many unique WhatsApp users can be messaged outside a customer service window in a rolling 24 hours, as WhatsApp's own tier token. WhatsApp calculates this…
WhatsAppNumberThroughputLevel
string
How fast WhatsApp lets this number send, as WhatsApp's own level token. standard is 80 messages per second; WhatsApp upgrades an eligible number to 1,000 per s…
WhatsAppNumber
object
19 properties
7 required
WhatsAppNumberList
NumbersDedicatedAllocationID
string
WhatsAppNumberCreate
object
3 properties
1 required
WhatsAppNumberPrecheckRequest
object
1 property
1 required
WhatsAppNumberPrecheckOutcome
string
Whether WhatsApp accepts this number. The available outcome means nothing prevents connecting it today. The unavailable outcome means WhatsApp refuses it. It m…
WhatsAppNumberPrecheckResult
object
2 properties
2 required
WhatsAppNumberUpdate
object
1 property
WhatsAppAgentCounts
object
How many items each of the agent's lists holds. Read the list itself for the items.
6 properties
6 required
WhatsAppAgent
WhatsAppAgentHandoffMessageSelection
string
Where the words the agent says to a contact as it hands a conversation over come from. - default uses WhatsApp's own standard wording. - agent lets the agent p…
WhatsAppAgentHandoffSettings
object
When the agent gives a conversation to your team, and what it tells the contact as it does.
3 properties
1 required
WhatsAppAgentFollowupInterval
integer
How long a contact has to be quiet before the agent follows up, in seconds. WhatsApp accepts these values only: five minutes, fifteen minutes, half an hour, on…
WhatsAppAgentFollowupSettings
object
Whether the agent writes again when a contact goes quiet, after how long, and what it says.
3 properties
1 required
WhatsAppAgentSettings
object
How the agent on a WhatsApp number behaves: whether it is answering and since when, who it may answer, how it hands over and follows up, and what it must never…
6 properties
6 required
WhatsAppAgentHandoffSettingsUpdate
object
When the agent should give a conversation to your team, and what to tell the contact as it does. Replaces the whole setting; once set it cannot return to null,…
3 properties
1 required
WhatsAppAgentFollowupSettingsUpdate
object
Whether the agent should write again when a contact goes quiet, after how long, and what to say. Replaces the whole setting; once set it cannot return to null,…
3 properties
1 required
WhatsAppAgentSettingsUpdate
object
The settings to change. Every field is optional and an omitted one is left as it is. The change is written to WhatsApp and saved once WhatsApp accepts it, taki…
5 properties
WhatsAppAgentBusinessContactInfo
object
How and when the business can be reached outside this conversation. Every field is optional.
3 properties
WhatsAppAgentBusinessInfo
object
What the agent knows about the business itself. Every field is optional, and what you leave out is something the agent cannot tell a contact. WhatsApp holds it…
6 properties
WhatsAppAgentBusinessContactInfoUpdate
object
How and when the business can be reached outside this conversation. Every field is optional. Null does not clear one of these: WhatsApp accepts the change and…
3 properties
WhatsAppAgentBusinessInfoUpdate
object
The parts of what the agent knows about the business to change. Every field is optional, and an omitted one is left as it is. Null clears any of the fields abo…
6 properties
WhatsAppAgentFAQID
string
WhatsAppAgentItemMetadata
object
Your own labels on an item, as string keys and string values. The agent does not read them; they are for your bookkeeping and are passed through to WhatsApp un…
WhatsAppAgentFAQ
WhatsAppAgentFAQList
WhatsAppAgentFAQCreate
object
A question and answer to add. It reaches WhatsApp before this request answers and is used from the next conversation turn.
3 properties
2 required
WhatsAppAgentFAQUpdate
object
The parts of a question and answer to change. An omitted field is left as it is.
3 properties
WhatsAppAgentWebsiteID
string
WhatsAppAgentWebsiteCrawlStatus
string
Where WhatsApp stands with reading the website. - pending means WhatsApp has accepted the site and not started reading it. - inprogress means it is reading the…
WhatsAppAgentWebsite
WhatsAppAgentWebsiteList
WhatsAppAgentWebsiteCreate
object
A website to add. Change the address later by updating the entry, which makes WhatsApp read the new page in place of the old one.
1 property
1 required
WhatsAppAgentWebsiteUpdate
object
The new address for a website the agent reads. What WhatsApp read from the old address is replaced by what it reads from the new one.
1 property
1 required
WhatsAppAgentFile
object
A document the agent answers from. WhatsApp holds only the name, so Bird keeps a copy of the bytes and serves them through url; delete the entry and upload aga…
6 properties
6 required
WhatsAppAgentFileList
WhatsAppAgentFileCreate
object
A document to upload for the agent to answer from, sent as a multipart/form-data body with the bytes in the file part.
2 properties
2 required
WhatsAppAgentSkillID
string
WhatsAppAgentSkill
WhatsAppAgentSkillList
WhatsAppAgentSkillCreate
object
A skill to add. It reaches WhatsApp before this request answers and is used from the next conversation turn.
3 properties
3 required
WhatsAppAgentSkillUpdate
object
The parts of a skill to change. An omitted field is left as it is.
3 properties
WhatsAppAgentUISkillID
string
WhatsAppAgentUISkillComponentType
string
Which of WhatsApp's rich message components the agent may answer with. - ctaurl is a button that opens a link. - image is an image sent with the answer. - inte…
WhatsAppAgentUISkill
WhatsAppAgentUISkillList
WhatsAppAgentUISkillCreate
object
A rich-message skill to add. It reaches WhatsApp before this request answers and is used from the next conversation turn.
4 properties
4 required
WhatsAppAgentUISkillUpdate
object
The parts of a rich-message skill to change. An omitted field is left as it is. componenttype is fixed at creation and is not here.
3 properties
WhatsAppAgentAllowlistEntryID
string
WhatsAppAgentAllowlistEntry
object
One contact the agent may answer while aiaudience is allowlist. The list is ignored while the audience is everyone, and kept, so narrowing the audience again p…
3 properties
3 required
WhatsAppAgentAllowlistEntryList
WhatsAppAgentAllowlistEntryCreate
object
A contact to add to the agent's allowlist. The agent answers them from the next conversation turn while aiaudience is allowlist.
1 property
1 required
WhatsAppAgentTestMessageRequest
object
A message to put to the agent. It is answered by the agent's live configuration, which is the only one there is, so a change you have just saved is what gets t…
2 properties
1 required
WhatsAppAgentTestMessageResponse
object
WhatsApp's answer to a test message, passed through with its field names aligned to this API: what the agent answered, or why it did not, and whether it would…
8 properties
4 required
WhatsAppAgentHandoffEventID
string
WhatsAppAgentHandoffInitiator
string
What caused this handoff. - app means your own application asked for it, with a handoff request on this number. - agent means the agent passed the conversation…
WhatsAppAgentHandoff
object
One change of who answers a contact's conversation on this number: a handoff you asked for, or the agent passing the conversation up after its handoff message.…
6 properties
6 required
WhatsAppAgentHandoffList
WhatsAppAgentHandoffAction
string
What to do with control of the conversation. - release gives control up, so the agent picks the conversation back up. Your application must hold it. - take cla…
WhatsAppAgentHandoffRequest
object
A change of control over one contact's conversation.
3 properties
2 required
WhatsAppAgentNotificationStatus
string
Where a notification you sent the agent stands. One state is transient and three are final. - accepted means Bird holds the notification: it is on its way to W…
WhatsAppAgentNotificationID
string
WhatsAppAgentNotificationError
object
Why a notification sent to the agent failed.
2 properties
2 required
WhatsAppAgentNotification
WhatsAppAgentNotificationList
WhatsAppAgentNotificationCreate
object
Something that happened in your systems that the agent should tell the contact about, such as a payment landing or an order shipping. WhatsApp processes it in…
4 properties
4 required
WhatsAppNumberEventSortField
string
Sortable fields for a WhatsApp number's event list.
WhatsAppNumberEventID
string
WhatsAppNumberEvent
object
5 properties
5 required
WhatsAppNumberEventList
WhatsAppDisplayNameStatus
string
Where WhatsApp's review of the display name stands. availablewithoutreview means the name met WhatsApp's criteria for immediate use without a review step, and…
WhatsAppUsernameStatus
string
Where the username stands with WhatsApp. WhatsApp adds states over time, so a value outside this list can be returned.
WhatsAppBusinessVertical
string
The industry WhatsApp shows on the business profile. WhatsApp adds categories over time, so a value outside this list can be returned.
WhatsAppNumberProfile
object
The business profile WhatsApp shows to people this number messages. It is read from WhatsApp on each request rather than from a stored copy, so it is always cu…
13 properties
WhatsAppUsernameTransferAction
string
What to do when the username you are asking for is already in use by another of your own WhatsApp numbers. none leaves it where it is and the request is refuse…
WhatsAppNumberProfileUpdate
object
The profile fields to change. Omit a field to leave it as it is. Not every field can be cleared by sending null, and each field's description says whether it c…
10 properties
AMBBusinessID
string
AMBBusinessStatus
string
Where the business record stands with Apple. Values, in lifecycle order: - draft means the record exists but carries no Apple Business ID yet. You move it to s…
AMBMSPApp
string
The regional Messaging Service Provider application this business is registered under. A separate application runs in each of eu1 and us1, each with its own Ap…
AMBBusiness
object
9 properties
9 required
AMBBusinessList
AMBBusinessCreateRequest
object
2 properties
1 required
AMBBusinessUpdateRequest
object
2 properties
AMBAuthenticationProviderID
string
AMBAuthenticationMethod
string
How Bird authenticates its confidential client to the identity provider. privatekeyjwt signs a client assertion with a Bird-managed private key; register the p…
AMBAuthenticationPublicJWK
object
Public signing key to register with your identity provider. The private key never leaves Bird.
6 properties
6 required
AMBAuthenticationProvider
object
Business authentication configuration. Contains no client secret, private key or end-user tokens.
11 properties
10 required
AMBAuthenticationProviderUpdateRequest
object
Configure one OpenID Connect provider for this business. Register Bird's callback URL and client details with the provider and Apple. Omit clientsecret to pres…
8 properties
6 required
AMBEntryPoint
object
4 properties
4 required
AMBChannelSettings
object
A business's entry points, default locale, and landing-page brand settings. OpenID Connect providers use separate business authentication provider operations.…
4 properties
3 required
AMBChannelSettingsUpdateRequest
object
4 properties
AMBPaymentEnvironment
string
Isolates provider test data from live merchant payments.
AMBApplePayConfigurationID
string
AMBPaymentConnectionID
string
AMBApplePaySupportedNetwork
string
AMBApplePayReadiness
string
AMBApplePayValidationCheckStatus
string
AMBApplePayValidationCheck
object
4 properties
4 required
AMBApplePayCredentialMetadata
object
6 properties
6 required
AMBApplePayConfiguration
object
19 properties
19 required
AMBApplePayConfigurationSave
object
10 properties
AMBApplePayValidation
object
4 properties
4 required
AMBPaymentProvider
string
AMBPaymentConnectionAvailability
string
AMBPaymentConnectionGrantStatus
string
Authorization state. Active means authorization is available, but does not by itself establish payment readiness. Disconnecting means new payments are blocked…
AMBPaymentConnection
object
10 properties
9 required
AMBPaymentAuthorizationOption
object
2 properties
2 required
AMBPaymentConnectionList
AMBPaymentConnectionAuthorizationRequest
object
3 properties
2 required
AMBPaymentAuthorizationID
string
AMBPaymentConnectionAuthorization
object
5 properties
5 required
AMBRoutingRuleID
string
AMBRoutingRuleMatchKind
string
What a routing rule matches against the entry point that started the conversation. - intent matches on the entry point's intent alone: matchintentid is set and…
AMBRoutingRule
A rule that puts a conversation into a queue when it is created or reopened, based on the group and intent the entry point that started it carried.
AMBRoutingRuleList
object
1 property
1 required
AMBRoutingRuleCreateRequest
object
7 properties
3 required
AMBRoutingRuleUpdateRequest
object
3 properties
AMBAttachmentUploadRequest
object
2 properties
2 required
AMBAttachmentUploadResult
object
Encrypted attachment reference. Include this object in a message's attachments array; keep its key private.
7 properties
5 required
AMBMessageID
string
AMBMediaKind
string
The interactive media to download. Images use their position in the images array; the app icon uses index zero.
AMBConversationID
string
AMBMessageDirection
string
Whether a message was sent by the business or received from the customer: - outbound: A reply the business sent into the conversation. - inbound: A message the…
AMBMessageStatus
string
Send status: - accepted: Accepted and queued for delivery to Apple. - sent: Handed to Apple. There is no delivery or read receipt on this channel, so sent is t…
AMBContentKind
string
Derived message classification for filtering and statistics. Send requests use the native content.type families; applepay and authenticate remain reserved. - t…
AMBMessageSource
string
Who sent an outbound message: - operator: A person, through a signed-in dashboard session. - automation: A workflow or bot acting on the workspace's behalf, th…
AMBMessageType
string
Apple message family.
AMBNativeAttachment
object
Provide sourceurl or the complete encrypted reference, never both.
8 properties
AMBNativeTextContent
object
4 properties
1 required
AMBNativeRichLinkImage
object
2 properties
1 required
AMBNativeRichLinkVideo
object
2 properties
1 required
AMBNativeRichLinkAssets
object
2 properties
1 required
AMBNativeRichLinkData
object
3 properties
3 required
AMBRichLinkReference
object
Reusable Apple content reference. Supply the decryption key, or the signed bid and datarefsig returned by Apple.
8 properties
4 required
AMBNativeRichLinkContent
object
6 properties
1 required
AMBMessageBubbleStyle
string
Layout of an Apple interactive message bubble.
AMBMessageBubble
object
8 properties
1 required
AMBNativeImage
object
3 properties
2 required
AMBQuickReplyItem
object
2 properties
2 required
AMBNativeQuickReply
object
2 properties
2 required
AMBListPickerItem
object
5 properties
2 required
AMBListPickerSection
object
4 properties
2 required
AMBNativeListPicker
object
1 property
1 required
AMBLocation
object
4 properties
AMBTimeSlot
object
3 properties
3 required
AMBNativeEvent
object
6 properties
1 required
AMBFormSplash
object
4 properties
1 required
AMBFormPageCommon
object
6 properties
3 required
AMBFormSelectItem
object
5 properties
3 required
AMBFormSelectPage
AMBFormPickerItem
object
3 properties
3 required
AMBFormPickerPage
AMBFormDatePickerOptions
object
Apple defaults to UTC when interpreting these dates.
5 properties
AMBFormDatePickerPage
AMBFormInputType
string
AMBFormKeyboardType
string
Apple UIKit value, passed through without changing its spelling.
AMBFormTextContentType
string
Apple UIKit value, passed through without changing its spelling.
AMBFormInputOptions
object
9 properties
AMBFormInputPage
AMBFormPage
AMBNativeFormData
object
5 properties
2 required
AMBNativeDynamic
object
Form content. Bird supplies Apple’s messageForms template and protocol version.
1 property
1 required
AMBAuthenticationID
string
AMBNativeAuthentication
object
Authentication attempt created through the conversation authentication endpoint. Contains no authorization parameters or credentials.
1 property
1 required
AMBPaymentID
string
AMBNativePayment
object
Apple Pay request created through the conversation payment endpoint. Contains no payment token or provider credentials.
1 property
1 required
AMBNativeInteractivePayload
object
Exactly one built-in interaction. Protocol versions are managed by Bird.
8 properties
AMBNativeInteractiveData
object
A built-in interaction or custom iMessage app. Custom apps require the app metadata and both message bubbles.
10 properties
AMBNativeInteractiveContent
object
6 properties
1 required
AMBMessageContent
Apple message families with Bird field naming and media URLs. Authentication and Apple Pay requests are created through their dedicated conversation endpoints.
AMBNativeInboundQuickReply
object
3 properties
1 required
AMBNativeInboundListPickerSection
object
4 properties
1 required
AMBNativeInboundListPicker
object
1 property
1 required
AMBNativeInboundEvent
object
6 properties
AMBFormPageType
string
AMBInboundFormItem
object
4 properties
4 required
AMBInboundFormSelection
object
4 properties
4 required
AMBNativeInboundFormData
object
2 properties
1 required
AMBNativeInboundDynamic
object
1 property
1 required
AMBNativeInboundPayment
object
1 property
AMBNativeInboundAuthentication
object
1 property
AMBNativeInboundImage
object
3 properties
2 required
AMBNativeInboundPayload
object
8 properties
AMBNativeInboundInteractiveData
object
10 properties
AMBNativeInboundInteractiveContent
object
5 properties
2 required
AMBInboundContent
Received text, attachments, and interactive replies, preserving Apple message structure.
AMBStatsErrorCode
string
Machine-readable reason a send failed, in one of two namespaces: bird: for a reason Bird's own pipeline assigned (for example bird:businessnotregistered), or a…
AMBError
objectnull
Failure detail for a message or invitation that could not be sent or was rejected.
3 properties
3 required
AMBMessage
object
18 properties
8 required
AMBMessageList
AMBMessageSendRequest
object
9 properties
3 required
AMBConstructPayloadRequest
object
3 properties
2 required
AMBConstructedPayload
object
2 properties
2 required
AMBMessageEventType
string
Message timeline event type: - amb.accepted: The API accepted the request. - amb.sent: The message was handed to Apple. - amb.sendfailed: Apple refused the mes…
AMBEventID
string
AMBMessageEvent
object
4 properties
3 required
AMBMessageEventList
object
1 property
1 required
AMBInvitationStatus
string
Send status: - queued: We accepted the invitation and queued it for sending. - sent: Apple's gateway accepted the invitation. This does not indicate a customer…
AMBInvitationID
string
AMBInvitationNotification
object
The Apple-managed template and values used to render an invitation.
4 properties
3 required
AMBInvitation
An invitation sent through Apple Messages for Business.
AMBInvitationList
AMBCreateInvitationRequest
object
An Apple Messages for Business invitation to send to a customer.
6 properties
3 required
AMBConversationStatus
string
Whether a conversation is open or closed. There is no close operation on this API: only the customer closes a conversation from their device, and any inbound m…
AMBConversationOrigin
string
How the conversation started. entrypoint means the customer opened it from one of your configured Apple Messages for Business entry points. invitation means yo…
AMBConversationClosedReason
string
Why a closed conversation was closed. userclose means the customer sent a close message from their device. gone means Apple returned a 410 for the conversation…
AMBAuthenticationStatus
string
Progress of a conversation identity verification attempt. pending waits for the customer or identity provider after the authentication message is accepted. pro…
AMBVerifiedIdentity
object
Validated identity claims. Verification does not create a persistent login session or grant access to customer systems.
7 properties
3 required
AMBAuthentication
object
A single attempt to verify the identity associated with an Apple Messages for Business conversation.
11 properties
8 required
AMBConversationVerifiedIdentity
object
Most recent successful identity verification for this conversation.
5 properties
5 required
AMBConversationAuthentication
object
Latest attempt and last successful verification. A new pending attempt does not erase an earlier success.
2 properties
AMBConversation
object
A conversation between your business and one customer on Apple Messages for Business. It holds the customer's device capabilities, the console's read state, as…
25 properties
22 required
AMBConversationList
AMBConversationUpdateRequest
object
Assignment, labels, and read state on a conversation. There is no close action here: only the customer closes a conversation, from their device. Every field is…
3 properties
AMBPaymentMethod
string
AMBPaymentStatus
string
Payment request status: - pending: Awaiting a payment attempt. A retryable decline returns the request to this status so the customer can try again before it e…
AMBPaymentError
object
2 properties
2 required
AMBPayment
object
20 properties
20 required
AMBPaymentList
AMBPaymentLineItem
object
2 properties
2 required
AMBPaymentCreateRequest
object
6 properties
4 required
AMBConversationTypingEvent
string
The typing signal to send. typingstart tells the customer's device that an operator is composing a reply. typingend tells it composition stopped without a mess…
AMBConversationTypingRequest
object
A typing indicator to send to the customer's device on this conversation.
1 property
1 required
AMBSuppressionHandleType
string
What kind of value handle holds. - phonenumber means handle is the customer's phone number. Apple's CloseSession event carries a phone number rather than an op…
AMBSuppressionReason
string
Why the handle is suppressed. manual means it was added directly through this API or the dashboard. optedout covers every case where Apple or the customer sign…
AMBSuppressionID
string
AMBSuppressionOrigin
string
How this episode came to exist. - user means a dashboard user added it directly. - apikey means an API caller added it directly. - closesession means the custo…
AMBSuppression
One period during which a handle is suppressed on one Apple Messages for Business brand, or across the whole workspace: when it started and, once it has ended,…
AMBSuppressionList
AMBSuppressionCreateRequest
object
3 properties
2 required
AMBStatsSummaryPeriod
object
The window the server actually computed against. The summary serves two window grains: calendar days (bounds are YYYY-MM-DD) and hours (bounds are RFC 3339 ins…
3 properties
2 required
AMBStatsAttribution
string
Which timestamp a statistics response buckets its rows and totals by: - acceptedtime: attributed to when Bird accepted the outbound message for sending. The ou…
AMBOutboundStatsCounts
object
Outbound Apple Messages for Business counts for the requested scope, attributed to when each message was accepted. Apple Messages for Business has no delivery…
6 properties
6 required
AMBStatsQuantiles
object
Approximate p50, p95, and p99 latency percentiles in milliseconds for one latency family. All three are null when no qualifying event contributed a measurement.
3 properties
3 required
AMBStatsLatency
object
Processing-latency percentiles in milliseconds for the requested scope, from acceptance to Apple handoff. Apple Messages for Business has no delivery receipt,…
1 property
1 required
AMBStatsComparisonDelta
object
Changes from the previous period. Each value is the signed relative change (current - previous) / previous and is null when the previous count is zero.
4 properties
4 required
AMBStatsComparison
object
The same statistics for the equal-length, inclusive period ending immediately before the requested start, together with the change between the two periods. Pre…
5 properties
4 required
AMBStatsSummary
object
Outbound Apple Messages for Business counts and latency percentiles for the full requested period. Counts and percentiles are computed over the whole period ra…
6 properties
4 required
AMBStatsSeriesPeriod
object
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
4 properties
3 required
AMBStatsPoint
object
Outbound Apple Messages for Business counts and processing-latency percentiles for one time bucket (a calendar day or hour), bucketed by acceptance time. Every…
3 properties
3 required
AMBStatsResponse
object
Time-series stats payload. period echoes the range and bucket grain the server computed against; data is one row per bucket in chronological order.
3 properties
3 required
AMBBusinessStatsPoint
object
Outbound counts and latency percentiles for a single business over the requested period.
4 properties
3 required
AMBStatsByBusinessResponse
object
Per-business breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
4 properties
4 required
AMBMessageKindStatsPoint
object
Outbound counts and latency percentiles for a single message content kind over the requested period.
4 properties
3 required
AMBStatsByMessageKindResponse
object
Per-content-kind breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
4 properties
4 required
AMBIntentStatsPoint
object
Outbound counts and latency percentiles for a single entry-point intent over the requested period.
4 properties
3 required
AMBStatsByIntentResponse
object
Per-intent breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
4 properties
4 required
AMBGroupStatsPoint
object
Outbound counts and latency percentiles for a single entry-point group over the requested period.
4 properties
3 required
AMBStatsByGroupResponse
object
Per-group breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
4 properties
4 required
AMBCategoryStatsPoint
object
Outbound counts and latency percentiles for a single message category over the requested period.
4 properties
2 required
AMBStatsByCategoryResponse
object
Per-category breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200).
4 properties
4 required
AMBTagStatsPoint
object
Outbound counts and latency percentiles for a single tag over the requested period.
4 properties
3 required
AMBStatsByTagResponse
object
Per-tag breakdown for the requested period, ranked by accepted volume descending and capped at the requested limit (default 50, max 200). Only tagged messages…
4 properties
4 required
AMBErrorCodeStatsPoint
object
Outbound counts and latency percentiles for a single failure reason over the requested period.
4 properties
3 required
AMBStatsByErrorCodeResponse
object
Per-failure-reason breakdown for the requested period, ranked by sendfailed + rejected descending and capped at the requested limit (default 50, max 200). Only…
4 properties
4 required
AMBInboundStatsComparisonDelta
object
The change from the preceding period to the requested one. The receivedpctchange field is a signed relative change, computed as (current - previous) / previous…
1 property
1 required
AMBInboundStatsComparison
object
The received-message count for the equal-length, inclusive period ending immediately before the requested start, together with the change between the two perio…
3 properties
3 required
AMBInboundStatsSummary
object
Total inbound Apple Messages for Business messages for the requested period.
4 properties
3 required
AMBInboundStatsPoint
object
Received-message count for one time bucket (a calendar day or hour), bucketed by the time each message occurred.
2 properties
2 required
AMBInboundStatsResponse
object
Received-message time series. period echoes the range the server computed against; data is one row per bucket in chronological order.
3 properties
3 required
AMBInboundBusinessStatsPoint
object
Received-message count for a single business over the requested period.
2 properties
2 required
AMBInboundStatsByBusinessResponse
object
Per-business breakdown of received messages for the requested period, ranked by volume descending and capped at the requested limit (default 50, max 200).
4 properties
4 required
AMBInboundIntentStatsPoint
object
Received-message count for a single entry-point intent over the requested period.
2 properties
2 required
AMBInboundStatsByIntentResponse
object
Per-intent breakdown of received messages for the requested period, ranked by volume descending and capped at the requested limit (default 50, max 200).
4 properties
4 required
AMBConversationStatsCounts
object
Conversation lifecycle counts for the requested scope, attributed to when each event occurred. A conversation can start, reopen, and close more than once over…
4 properties
4 required
AMBConversationStatsComparisonDelta
object
Changes from the previous period. Each value is the signed relative change (current - previous) / previous and is null when the previous count is zero.
4 properties
4 required
AMBConversationStatsComparison
object
The same statistics for the equal-length, inclusive period ending immediately before the requested start, together with the change between the two periods. Pre…
3 properties
3 required
AMBConversationStatsSummary
object
Conversation lifecycle counts for the full requested period. Counts aggregate the time buckets.
4 properties
3 required
AMBConversationStatsPoint
object
Conversation lifecycle counts for one time bucket (a calendar day or hour), bucketed by when each event occurred.
2 properties
2 required
AMBConversationStatsResponse
object
Conversation lifecycle time series. period echoes the range and bucket grain the server computed against; data is one row per bucket in chronological order.
3 properties
3 required
WhatsAppSignupNumber
object
5 properties
2 required
WhatsAppSignupNumberList
object
1 property
1 required
WhatsAppBusinessAccountSortField
string
Sortable fields for a WhatsApp Business Account list.
WhatsAppBusinessAccountStatus
string
WhatsApp's own state for a WhatsApp Business Account. Values are WhatsApp's own tokens, lower-cased. This enum is open because WhatsApp documents the field in…
WhatsAppBusinessAccountReviewStatus
string
How far WhatsApp's own review of this WhatsApp Business Account has got. deferred is WhatsApp postponing the review rather than refusing it. Values are WhatsAp…
WhatsAppBusinessVerificationStatus
string
Whether Meta has verified the business behind this WhatsApp Business Account. Verification is one of the paths to a higher messaging limit, so a value other th…
WhatsAppBusinessAccountMarketingMessagesStatus
string
Whether this account can use WhatsApp's Marketing Messages API. eligible means WhatsApp would accept an onboarding request for it; onboarded means it has alrea…
WhatsAppBusinessPortfolioMarketingMessagesStatus
string
How far the business portfolio has got through Meta's Marketing Messages terms of service. - notstarted: the portfolio has not begun the process. - requestsent…
WhatsAppBusinessPortfolio
object
The Meta business portfolio that owns a WhatsApp Business Account. Bird holds no resource of its own for a portfolio, which is why the identifier is named meta…
3 properties
1 required
WhatsAppBusinessAccountBanState
string
Whether WhatsApp has disabled a WhatsApp Business Account or scheduled it to be disabled: - disabled: WhatsApp has disabled the account, and it cannot send. -…
WhatsAppBusinessAccountBan
object
WhatsApp's ban on this account, as WhatsApp announced it. Absent when there is no ban, and also when there is one WhatsApp announced before Bird began recordin…
3 properties
2 required
WhatsAppBusinessAccount
object
12 properties
6 required
WhatsAppBusinessAccountList
WhatsAppSuppressionID
string
WhatsAppSuppression
object
One period during which an address is suppressed: when it started and, once it is over, what ended it. An address suppressed, ended and suppressed again has tw…
10 properties
6 required
WhatsAppSuppressionList
WhatsAppSuppressionCreate
object
2 properties
1 required
WhatsAppSuppressionBulkCreate
object
1 property
1 required
WhatsAppSuppressionBulkResultItem
object
One row's result. Which optional fields accompany the outcome is stated per field rather than encoded as a oneOf: outcome is an extensible enum, so a closed di…
3 properties
1 required
WhatsAppSuppressionBulkResult
object
1 property
1 required
WhatsAppKeywordOperation
string
What Bird does when an inbound message matches the rule. - optout records that the sender no longer consents to receive any messages from your WhatsApp Busines…
WhatsAppKeywordRuleScope
string
Whether the rule is one Bird ships (system) or one your workspace created (workspace). Both kinds carry a wkr ID and can be read; only a workspace rule can be…
WhatsAppKeywordRuleID
string
WhatsAppKeywordRule
object
10 properties
7 required
WhatsAppKeywordRuleList
object
1 property
1 required
WhatsAppKeywordOperationWrite
string
What Bird does when an inbound message matches the rule. - optout records that the sender no longer consents to receive any messages from your WhatsApp Busines…
WhatsAppKeywordRuleCreate
object
5 properties
1 required
WhatsAppKeywordRuleUpdate
object
Changes the reply and the added keywords. What a rule applies to (its operation, country and WhatsApp Business Account) is fixed once created: those decide whi…
2 properties
EmailInboxInsightsGroupBy
string
The bucket size a series is grouped by. Day suits the product's charts; wider grains suit long ranges.
EmailInboxInsightsCompare
string
Set to previousperiod to include the immediately preceding window of equal length in the same response, so deltas need no second request.
EmailInboxInsightsWeightingSource
string
Where the audience mix behind the placement weighting came from: account when it was configured for this account, global when a general default was used instea…
EmailInboxInsightsWeighting
object
How the placement figures in this response were weighted, so a number is self-describing wherever it is quoted or screenshotted. Placement rates are a weighted…
3 properties
3 required
EmailInboxInsightsMeasurement
object
How the figures in this response were measured, so a number is self-describing in a screenshot or a bug report.
2 properties
1 required
EmailInboxInsightsFreshness
object
How current the figures are. Freshness differs per resource (authentication data can lag a day or more while blocklist lookups are near real time), so any "as…
2 properties
2 required
EmailInboxInsightsEnvelopeBase
object
The meta every Inbox Insights resource carries, whatever it measures, so one client adapter serves them all.
6 properties
4 required
EmailInboxInsightsWindow
object
The period every figure in the response covers: whole UTC calendar days, inclusive on both ends. The same window convention the email statistics endpoints use,…
3 properties
2 required
EmailInboxInsightsComparedTo
object
The prior equal-length period the delta figures compare against. Present only when the request asked for a comparison.
2 properties
2 required
EmailInboxInsightsEnvelope
object
The meta a windowed Inbox Insights resource carries: the common fields plus the period the figures cover and how they were measured.
EmailInboxInsightsPlacementCounts
object
Raw measured placements behind a set of rates, before any weighting. A measured placement is one message whose mailbox destination the measurement observed.
4 properties
4 required
EmailInboxInsightsPlacementDeltaPts
object
How the domain-wide rates moved against the prior period, in percentage points. Present only when the request asked for a comparison and the prior period had d…
2 properties
2 required
EmailInboxInsightsSectionStatus
string
Whether a section of the response carries figures, and when it does not, why. ok means the section is populated. nodata means the measurement ran and observed…
EmailInboxInsightsPlacementSummary
object
The domain-wide placement figures for the period. These rates are weighted against the audience mix in measurement.weighting, so they can legitimately differ f…
7 properties
6 required
EmailInboxInsightsMailboxProvider
string
A mailbox provider, as the measurement identifies it. A lowercase identifier rather than a display name, so pick your own label for it, and treat the set as op…
EmailInboxInsightsPlacementProvider
object
One mailbox provider's placement for the period. Unlike the domain-wide summary, a single provider's rates are unweighted: there is no audience mix to weight w…
6 properties
5 required
EmailInboxInsightsPlacementProviders
object
The per-provider placement table.
2 properties
2 required
EmailInboxInsightsPlacementSeriesPoint
object
One bucket of the placement series.
6 properties
6 required
EmailInboxInsightsPlacementSeries
object
The placement time series, at the grain named in window.groupby. The series is sparse: buckets with no measured placement are omitted rather than returned as z…
2 properties
2 required
EmailInboxInsightsGmailTab
string
A Gmail tab, as the measurement identifies it. A lowercase identifier rather than a display name, so pick your own label for it, and treat the set as open: the…
EmailInboxInsightsGmailTabCategory
object
How the domain's Gmail-placed mail split across one Gmail tab.
4 properties
4 required
EmailInboxInsightsGmailTabs
object
Where the domain's Gmail-placed mail landed across Gmail's tabs. The status is notapplicable when the domain had no Gmail placement in the period; hide the sec…
2 properties
2 required
EmailInboxInsightsPlacementIpDetail
object
One sending IP's placement and authentication pass rates for the period.
5 properties
5 required
EmailInboxInsightsPlacementIpDetails
object
Per-IP placement detail for the domain's sending infrastructure. Returned only when the request asked for IP detail.
2 properties
2 required
EmailInboxInsightsPlacement
Where a sending domain's measured mail landed over the period: the domain-wide summary, the per-provider table, the time series, the Gmail tab split, and optio…
EmailInboxInsightsAuthPassRate
object
One authentication check's pass rate over the period.
4 properties
3 required
EmailInboxInsightsDmarcPolicy
string
The DMARC policy published in the domain's DNS record: what receivers are asked to do with mail that fails DMARC.
EmailInboxInsightsDmarcReadinessReason
string
Why the domain is not yet ready to move its DMARC policy to reject. sourcebelowthreshold means at least one legitimate sender is not authenticating well enough…
EmailInboxInsightsDmarc
object
The domain's DMARC standing over the period.
7 properties
6 required
EmailInboxInsightsDmarcVerdict
string
How a sending source's mail authenticates against the domain's DMARC policy. aligned passes with both SPF and DKIM aligned; dkimonly and spfonly pass on one me…
EmailInboxInsightsAuthSource
object
One system observed sending as this domain, with how its mail authenticates.
8 properties
8 required
EmailInboxInsightsAuthSources
object
Every system observed sending as this domain, with how each authenticates. This is the table that shows who else sends under the domain's name.
3 properties
3 required
EmailInboxInsightsAuthentication
Whether the domain's mail authenticates, and who sends as the domain: SPF and DKIM pass rates, the DMARC standing with its published policy, and the per-source…
EmailInboxInsightsComplaintPeak
object
The worst day for complaints in the period.
2 properties
2 required
EmailInboxInsightsComplaintRate
object
The rate at which the domain's mail is reported as spam, as Google Postmaster measures it.
4 properties
2 required
EmailInboxInsightsComplaintSeriesPoint
object
One bucket of the complaint-rate series.
2 properties
2 required
EmailInboxInsightsComplaintSeries
object
The complaint-rate series, at the grain named in window.groupby. Index by date, never by position.
2 properties
2 required
EmailInboxInsightsComplaints
How often the domain's mail is reported as spam, as Google Postmaster measures it. This is Google's number for Gmail-received mail only; the feedback-loop comp…
EmailInboxInsightsTrapType
string
What kind of spam trap was hit. pristine addresses were never used by a real person and never subscribed to anything, so a hit means the address was harvested…
EmailInboxInsightsSpamTrapTypeCount
object
Trap hits of one kind.
2 properties
2 required
EmailInboxInsightsTrapSource
string
The trap network that observed a hit. The set grows as coverage does, so treat the values as labels rather than a closed list.
EmailInboxInsightsSpamTrapSourceCount
object
Trap hits attributed to one trap network.
2 properties
2 required
EmailInboxInsightsSpamTrapHit
object
One trap address this domain's mail reached, with enough detail to trace where the address came from. A row can represent several hits on the same trap, so rea…
7 properties
6 required
EmailInboxInsightsSpamTrapHits
object
The individual trap hits behind the totals. A sample rather than a guaranteed complete list, and its rows do not count hits: one row is one trap address, carry…
3 properties
3 required
EmailInboxInsightsSpamTraps
Whether the domain's mail is reaching spam traps: addresses that exist only to catch senders mailing lists they should not be mailing. Zero hits is a measured…
EmailInboxInsightsBlocklistListing
object
One listing of a target on one blocklist.
6 properties
6 required
EmailInboxInsightsBlocklistTarget
object
One target lookup result, its current status, and the listings seen against it. Read status before islisted. Each target is looked up independently and any one…
6 properties
6 required
EmailInboxInsightsBlocklists
Whether the domain's sending infrastructure is on any blocklist, checked when the request is made. This is a live lookup rather than a measurement over a perio…
EmailInboxInsightsIndustry
object
The industry a sending domain was classified into.
2 properties
2 required
EmailInboxInsightsIndustryBenchmark
How senders in a domain's industry place, as a median across the industry's measured senders. The benchmark describes the industry, not the domain, so it carri…
EmailInboxInsightsSeedListType
string
Which pool of seed addresses a test uses. Which pools an account can use depends on what has been provisioned for it, so read the usable set from the seed-test…
EmailInboxInsightsSeedEngagementProfile
string
Which engagement behaviour the seed addresses simulate. all mixes engaged and dormant seeds, which is what makes an engagement split measurable; single-cohort…
EmailInboxInsightsSeedTestSummary
object
The fields every view of a seed test carries. There is no status field. The measurement reports none for a test it has already run, and nothing else on the sur…
7 properties
7 required
EmailInboxInsightsSeedTestRow
One seed test as it appears in the history list.
EmailInboxInsightsSeedTestList
object
The domain's seed tests over the period, newest first, up to 100 of them. The list is capped rather than paged, so truncated says whether older tests in the pe…
3 properties
3 required
EmailInboxInsightsGmailCategory
object
Which Gmail tab the test's Gmail seeds mostly landed under.
2 properties
2 required
EmailInboxInsightsSeedTestProvider
object
How one mailbox provider treated the test, with the seed counts behind the rates. Seed counts are small by nature, so a single seed moves a rate noticeably.
7 properties
6 required
EmailInboxInsightsSeedTestProviders
object
The per-provider grid for one seed test.
2 properties
2 required
EmailInboxInsightsSeedTestAuth
object
How the tested send authenticated, measured on the seed mail itself rather than on reporting from receivers.
4 properties
4 required
EmailInboxInsightsSeedEngagementSplitRow
object
How one provider treated engaged seeds against dormant ones. A gap means the provider is sorting the same mail differently by how the recipient behaves.
6 properties
6 required
EmailInboxInsightsSeedEngagementSplit
object
Engaged against dormant placement, per provider. The status is notapplicable for a test run with a single-cohort engagement profile, where there is no second g…
2 properties
2 required
EmailInboxInsightsSeedTestDetail
object
One seed test with its full results.
EmailInboxInsightsSeedTestQuota
object
The workspace's seed-test allowance for the current month. Registering a test spends one of the allowance whether or not its send goes out, and a test that exp…
3 properties
3 required
EmailInboxInsightsSeedTests
The domain's seed tests over the period, with the newest test's full results and the workspace's monthly allowance. A seed test sends to a panel of real mailbo…
EmailInboxInsightsSeedTestCreate
object
How to configure a seed test. The choices available for a domain come from the seed-test configuration.
5 properties
4 required
EmailInboxInsightsSeedAddress
object
One seed address to include in the tested send.
4 properties
4 required
EmailInboxInsightsSeedTestRegistration
object
A registered seed test and the addresses it measures. Registering a test does not put the addresses into a send. Add them to the recipients of the send you wan…
4 properties
4 required
EmailInboxInsightsSeedListTypeOption
object
One seed pool a test can be run against, and whether this account can use it.
2 properties
2 required
EmailInboxInsightsSeedRegionOption
object
One region seeds can be placed in.
1 property
1 required
EmailInboxInsightsSeedEngagementProfileOption
object
One engagement behaviour a test can simulate, and whether this account can use it.
2 properties
2 required
EmailInboxInsightsSeedTestConfiguration
object
The choices available when registering a seed test for a domain: which seed pools the account can use, which regions seeds can be placed in, and which engageme…
5 properties
5 required
EmailInboxInsightsDomainSort
string
Field used to sort owned domains.
EmailInboxInsightsDomain
object
One of the workspace's verified sending domains, and whether Inbox Insights is switched on for it.
2 properties
2 required
EmailInboxInsightsDomains
A page of sending domains this workspace can report on, and which of them Inbox Insights is switched on for.
EmailInboxInsightsDomainUpdate
object
The Inbox Insights setting to change for a sending domain.
1 property
1 required
EmailInboxInsightsDomainMonitoringOutcome
string
What switching on the main sending domain did. - enabled: Inbox Insights is now switched on for the domain named alongside this. - alreadyon: at least one doma…
EmailInboxInsightsDomainMonitoringResult
object
What switching on the workspace's main sending domain did. There are four outcomes, because each one leaves the customer somewhere different: one domain is now…
2 properties
2 required
EmailStatsSeriesPeriod
object
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
4 properties
3 required
EmailBounceStatsWithRates
object
Breakdown of bounced by failure type, with each rate as a fraction of bounced. Counts are distinct bounced recipients of that type; the five types approximatel…
10 properties
10 required
EmailDeliveryStats
object
Delivery counts and rates for the scope of the containing row (a time bucket, a breakdown dimension, or the whole period). Every count is the number of distinc…
15 properties
14 required
EmailEngagementStats
object
Engagement counts and rates for the scope of the containing row (a time bucket, a breakdown dimension, or the whole period). opens, opensnonprefetched and clic…
10 properties
10 required
EmailLatencyQuantiles
object
Approximate p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. All three are null when no qualifying event contribut…
3 properties
3 required
EmailLatencyStats
object
Latency percentiles (p50, p95, p99) in milliseconds for the bucket. On the summary endpoint these are computed across the whole period rather than per bucket.…
3 properties
EmailStatsPoint
object
Aggregate stats for one time bucket (a calendar day or hour, per the requested grain, in the requested timezone or UTC by default), bucketed by event time. Buc…
5 properties
5 required
EmailStatsResponse
object
Time-series stats payload. period echoes the range and bucket grain actually computed against. data is one row per bucket in chronological order.
2 properties
2 required
EmailStatsSortMetric
string
Metric to rank breakdown rows by, applied descending. Shared by the breakdowns whose rows have the full delivery, engagement, and latency block: tags, sending…
EmailStatsPeriod
object
The date range this response was actually computed against. Echoed back so clients can render the period without tracking it themselves and so cached responses…
3 properties
2 required
EmailStatsSeriesPoint
object
One point in a breakdown row's trend series: the headline delivery and engagement rates for that row's dimension value over a single day or hour. Returned only…
8 properties
8 required
EmailTagStatsPoint
object
Aggregate delivery and engagement stats for a single tag name-and-value pair over the requested period.
5 properties
4 required
EmailStatsTagsResponse
object
Per-tag breakdown for the requested period, ranked by the sort metric (default processed) descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
EmailStatsSummaryPeriod
object
The window this response was actually computed against. The summary serves two window grains: calendar days (bounds are YYYY-MM-DD) and hours (bounds are RFC 3…
3 properties
2 required
EmailStatsComparisonDelta
object
The change in each headline metric from the preceding period to the requested one. A pctchange field is a signed relative change in a count, computed as (curre…
11 properties
11 required
EmailStatsComparison
object
The same statistics for the equal-length, inclusive period ending the day immediately before the requested start, together with the change between the two peri…
6 properties
6 required
EmailStatsSummary
object
A single row that aggregates delivery and engagement counts, plus derived rates, across the whole requested period. Use this endpoint for KPI tiles, campaign r…
6 properties
5 required
EmailInboundStatsSummary
object
A single-row received-email total across the full requested period. It is the sum of the per-bucket counts across the window, and because each message is recei…
2 properties
2 required
EmailInboundStatsPoint
object
Received-email counts for one time bucket, a calendar day or hour depending on the requested grain, bucketed by when the message was received. Buckets with no…
2 properties
2 required
EmailInboundStatsResponse
object
Time-series received-email stats payload. period echoes the range and bucket grain used to compute this response. data is one row per bucket in chronological o…
2 properties
2 required
IPPoolID
string
EmailSendingIpDeliveryStats
object
Delivery counts and rates for messages attributed to a single sending IP. Per-IP results omit accepted and processed counts. The sending IP becomes known only…
12 properties
12 required
EmailDeliveryLatencyStats
object
Latency percentiles (p50, p95, p99) in milliseconds for the messages in this breakdown row, for breakdowns whose dimension is known only from delivery onward (…
2 properties
2 required
EmailSendingIpStatsPoint
object
Delivery and latency stats for messages sent from a single IP address over the requested period. Per-IP attribution begins only after a message is processed: w…
5 properties
3 required
EmailStatsBySendingIpResponse
object
Per-sending-IP breakdown for the requested period, ranked by the sort metric (default delivered) descending and capped at the requested limit (default 50, max…
3 properties
3 required
EmailSendingDomainStatsPoint
object
Aggregate delivery, engagement, and latency stats for messages sent from a single sending domain over the requested period.
5 properties
4 required
EmailStatsBySendingDomainResponse
object
Per-sending-domain breakdown for the requested period, ranked by the sort metric (default processed) descending and capped at the requested limit (default 50,…
3 properties
3 required
EmailCategoryStatsPoint
object
Aggregate delivery and engagement stats for a single category over the requested period.
5 properties
4 required
EmailStatsByCategoryResponse
object
Per-category breakdown for the requested period, ranked by the sort metric (default processed) descending and capped at the requested limit (default 50, max 20…
3 properties
3 required
EmailMailboxProviderSortMetric
string
Metric to rank rows by, applied descending. Shared by every breakdown whose attribution begins at delivery, so processed, rejected, and oobbounces are not part…
EmailMailboxProviderDeliveryStats
object
Delivery counts and rates for messages attributed to a single recipient mailbox provider. Per-provider results do not include accepted or processed counts, bec…
8 properties
8 required
EmailMailboxProviderStatsPoint
object
Delivery, engagement, and deliverability stats for messages grouped by a single recipient mailbox provider (gmail, microsoft, yahoo, apple, ...) over the reque…
5 properties
4 required
EmailStatsByMailboxProviderResponse
object
Per-mailbox-provider breakdown for the requested period, ranked by the sort metric (default delivered) descending and capped at the requested limit (default 50…
3 properties
3 required
EmailMailboxProviderForSendingDomainStatsPoint
object
Delivery, engagement, and deliverability figures for one sending domain's mail at a single recipient mailbox provider (gmail, microsoft, yahoo, apple, ...) ove…
6 properties
6 required
EmailStatsByMailboxProviderForSendingDomainResponse
object
Per-mailbox-provider breakdown for one sending domain over the requested period, ranked by the sort metric (default delivered) descending and capped at the req…
4 properties
4 required
EmailMailboxProviderRegionStatsPoint
object
Delivery, engagement, and deliverability stats for messages grouped by a single mailbox provider and provider region pair over the requested period, for exampl…
6 properties
5 required
EmailStatsByMailboxProviderRegionResponse
object
Per-(mailbox provider, provider region) breakdown for the requested period, ranked by the sort metric (default delivered) descending and capped at the requeste…
3 properties
3 required
EmailRecipientDomainStatsPoint
object
Aggregate delivery, engagement, and latency stats for messages sent to a single recipient mailbox domain over the requested period.
5 properties
4 required
EmailStatsByRecipientDomainResponse
object
Per-recipient-domain breakdown for the requested period, ranked by the sort metric (default processed) descending and capped at the requested limit (default 50…
3 properties
3 required
EmailTemplateStatsPoint
object
Delivery, engagement, and latency numbers for every message sent with one template over the requested period.
5 properties
4 required
EmailStatsByTemplateResponse
object
Per-template breakdown for the requested period, ranked by the sort metric (default processed) descending and capped at the requested limit (default 50, max 20…
3 properties
3 required
EmailEngagementSortMetric
string
Metric to rank rows by, applied descending. Shared by the engagement-only breakdowns (locations, email clients), which report open and click counts but no rate…
EmailEngagementCounts
object
Open and click counts for a breakdown row whose dimension is resolved from engagement events only. opens, opensnonprefetched, and clicks count each event. The…
6 properties
6 required
EmailLocationStatsPoint
object
Open and click counts for messages engaged with from a single location over the requested period. Location is resolved from open and click events only, so this…
4 properties
4 required
EmailStatsByLocationResponse
object
Per-location engagement breakdown for the requested period, grouped at the requested groupby granularity, ranked by the sort metric (default uniqueopens) desce…
3 properties
3 required
EmailClientStatsPoint
object
Engagement counts for messages opened or clicked from a single email client, operating system, or device type over the requested period. The reading environmen…
4 properties
4 required
EmailStatsByClientResponse
object
Per-client engagement breakdown for the requested period, grouped by the requested groupby facet, ranked by the sort metric (default uniqueopens) descending an…
3 properties
3 required
EmailBounceStats
object
Breakdown of bounced by failure type. Each field counts distinct bounced recipients of that type in this row's scope; the five types approximately partition bo…
5 properties
5 required
EmailBounceCodeStatsPoint
object
Bounce counts for a single SMTP status code over the requested period, with the per-type breakdown. This is a deliverability-debugging view keyed on what the r…
3 properties
3 required
EmailStatsByBounceCodeResponse
object
Per-SMTP-code bounce breakdown for the requested period, ranked by the sort metric (default bounced) descending and capped at the requested limit (default 50,…
3 properties
3 required
EmailComplaintTypeStatsPoint
object
Complaint counts for a single feedback-loop complaint type over the requested period. A complaint type is recorded only on spam-complaint events, so this break…
2 properties
2 required
EmailStatsByComplaintTypeResponse
object
Per-complaint-type breakdown for the requested period, ranked by complained descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
EmailBroadcastStatsPoint
object
Delivery, engagement and latency figures for one broadcast's messages over the period you asked for.
4 properties
4 required
EmailStatsByBroadcastResponse
object
Per-broadcast breakdown for the requested period, ranked by the sort metric (default processed) descending and capped at the requested limit (default 50, max 2…
3 properties
3 required
EmailHealthSignalThresholds
object
The boundaries this signal's status was judged against. Use them to classify your own slices, such as per-domain or per-tag rates, against the same bands. The…
3 properties
3 required
EmailHealthSignal
object
The current value and verdict for a single sending-health metric over the window.
5 properties
4 required
EmailHealth
object
The workspace's current sending-health verdict over the requested window, plus reference deliverability limits and classification boundaries. Use it to render…
3 properties
3 required
DomainSettings
object
Per-domain behavior toggles. Changes apply immediately to new sends.
2 properties
DomainDKIM
object
Active DKIM signing configuration for the domain.
3 properties
3 required
DomainCapabilityPending
object
A staged configuration change awaiting DNS verification. The currently active configuration keeps serving until the staged one verifies, at which point it is p…
2 properties
2 required
DomainCapability
object
4 properties
1 required
DomainCapabilities
object
5 properties
4 required
DNSRecord
object
10 properties
8 required
Domain
object
14 properties
11 required
DomainList
DomainReturnPathConfig
object
Return-path (bounce) domain configuration. The return-path domain receives bounce and complaint notifications for mail sent from this domain and is what mailbo…
1 property
1 required
DomainTrackingConfig
object
Tracking domain configuration for branded open and click tracking URLs. Provide only the name part; we add the sending domain automatically. A domain created w…
1 property
1 required
DomainDKIMConfig
object
DKIM signing configuration.
1 property
DomainCreate
object
5 properties
1 required
DomainInboundConfig
object
Inbound (receiving) configuration. Enable inbound to receive email addressed to this domain. We return MX records to publish. After they verify, mail to any lo…
1 property
1 required
DomainUpdate
object
Partial update. settings changes apply immediately. Changes to returnpath, tracking, or dkim on a verified capability are staged. The current configuration kee…
5 properties
DomainEventID
string
DomainEvent
object
5 properties
5 required
DomainEventList
ShareDomainDnsRequest
object
1 property
1 required
DedicatedIPID
string
DedicatedIP
object
13 properties
10 required
DedicatedIPList
IPPoolSummary
A named group of dedicated IPs that share a sending reputation for email, without the member IP addresses. Fetch those with GET /v1/organization/ip-pools/{ippo…
IPPoolList
IPPool
A named group of dedicated IPs that share a sending reputation for email. Sends select a pool by name; sends that do not specify one use the organization's def…
DedicatedIPCreate
object
2 properties
IPResourcePurchaseResult
object
4 properties
3 required
DedicatedIPPurchaseResponse
object
1 property
1 required
DedicatedIPAssign
object
1 property
1 required
IPPoolCreate
object
Parameters for creating an IP pool.
1 property
1 required
IPPoolUpdate
object
Fields to update on an IP pool. Omitted fields are unchanged.
2 properties
SuppressionReasonFilter
string
SuppressionScopeTypeFilter
string
SuppressionID
string
SuppressionScopeType
string
How widely the email suppression applies. Responses use workspace. The values category, audience, topic, contact, and domain are reserved and have no records.…
SuppressionScope
object
2 properties
2 required
Suppression
object
9 properties
7 required
SuppressionList
SuppressionCreate
object
1 property
1 required
SuppressionBulkCreate
object
1 property
1 required
SuppressionBulkResultItem
object
One row's result. Which optional fields accompany the outcome is stated per field rather than encoded as a oneOf: outcome is an extensible enum, so a closed di…
3 properties
1 required
SuppressionBulkResult
object
1 property
1 required
EmailUnsubscribePageColor
string
A color on the hosted unsubscribe page, as a hex value like 0f172a.
EmailUnsubscribePage
object
Workspace-wide settings for the hosted unsubscribe page shown to recipients of marketing email.
5 properties
5 required
EmailUnsubscribePageUpdate
object
Partial update of the unsubscribe-page settings. Omitted fields keep their current value.
4 properties
EmailCompetitivePeriod
object
The period every figure in the response covers, echoed back from the request. Figures are fetched when the request is made, so they are current as of to. The p…
3 properties
3 required
EmailCompetitiveWatchlistSummary
object
Where your sending sits against the brands you watch, over the same period as the rows. Every figure here is derived from those rows rather than measured separ…
6 properties
6 required
CompetitiveWatchlistBrandID
string
EmailCompetitivePanelStatus
string
Whether panel figures are available for a row, and when they are not, why. ok means the panel reported figures for the requested period. notinpanel means the p…
EmailCompetitiveCampaignSummary
object
The most recent campaign observed for a brand in the period.
4 properties
4 required
EmailCompetitiveFieldSource
string
Where a figure came from. measured means it is counted from your own sending. panel means it is an estimate from an email panel, which observes a sample of rea…
EmailCompetitiveWatchlistRowProvenance
object
Where each figure on the row came from, so a comparison can be labelled honestly. Every field on a competitor's row is a panel estimate. On your own row the so…
6 properties
6 required
EmailCompetitiveWatchlistRow
object
One brand on the watchlist, with its figures for the requested period. Your own workspace appears as a row too, so the table can be read as a single ranking. E…
16 properties
15 required
EmailCompetitiveWatchlist
object
The workspace's competitor watchlist with its figures for the requested period. The list is capped by the organization's competitor limit and is returned whole…
3 properties
3 required
EmailCompetitiveCampaignSignal
string
Why this campaign was surfaced. The set is open and grows as new signals are added. Every signal describes the campaign against its own brand's history, never…
EmailCompetitiveNotableClaim
object
What the panel itself asserts about a campaign, in its own words. Present only on the campaigns the panel chose to make a claim about, which is a minority of t…
1 property
1 required
EmailCompetitiveNotableEvidence
object
The figures behind a campaign's signal, for ordering or filtering the list yourself. Which field carries a value depends on the signal, and each is null both o…
4 properties
4 required
EmailCompetitivePanelMailboxProvider
string
A mailbox provider, as the email panel identifies it. A lowercase identifier rather than a display name, so pick your own label for it, and treat the set as op…
EmailCompetitiveCampaign
One campaign an email panel observed a brand sending.
EmailCompetitiveNotableCampaign
object
A campaign the panel surfaced, and the reason it did.
7 properties
7 required
EmailCompetitiveNotableFeed
object
Campaigns worth a second look across the brands a workspace watches.
4 properties
4 required
EmailCompetitiveBrandID
string
Identifier of the brand in the panel's catalog, used to add it to the watchlist. It is a string for the same reason a campaign id is: the values are wide enoug…
EmailCompetitiveWatchlistBrandCreate
object
The brand to add to the watchlist. Obtained from a brand search, which only returns brands that can be watched.
1 property
1 required
EmailCompetitiveWatchlistBrand
A brand on the workspace's watchlist. This is the watchlist entry itself, with no figures on it; read the watchlist to get those.
EmailCompetitiveProviderPlacement
object
How one mailbox provider treated a brand's mail, beside your own.
4 properties
4 required
EmailCompetitiveBrandProfile
object
One watched brand's figures for the period, with its placement broken out by mailbox provider.
3 properties
3 required
EmailCompetitiveCampaignSort
string
Field used to sort campaigns.
EmailCompetitiveCampaignFeed
A page of campaigns returned for a watched brand over the period.
EmailCompetitiveWeekday
string
A day of the week. Named rather than numbered because the two common numberings disagree about which day the week starts on.
EmailCompetitiveSendTimeCell
object
One weekday and hour of a brand's sending week.
5 properties
5 required
EmailCompetitiveSendTimePeak
object
The hour of the day a brand sends most of its mail in.
3 properties
3 required
EmailCompetitiveSendTimeGrid
object
When a watched brand sends, by weekday and hour of the day.
5 properties
5 required
EmailCompetitiveBrandMatch
object
A brand matching a search, ready to be added to the watchlist.
3 properties
3 required
EmailCompetitiveBrandSearchResults
object
Brands matching the search. Ranked by how well they match, best first, and capped at 8 results because this backs a type-ahead. The panel's own answer is often…
1 property
1 required
EmailCompetitiveVolumePoint
object
One day of one line on the volume chart.
2 properties
2 required
EmailCompetitiveBrandSeries
object
One line on the volume chart: a watched brand's sending over time, or your own.
7 properties
6 required
EmailCompetitiveVolumeSeries
object
Volume over time for the requested watched brands, plus your own sending, on one shared daily axis.
2 properties
2 required
EmailTemplateCategory
string
Whether the template is for transactional email or marketing email.
EmailTemplateSource
string
The authoring format the template is written in, fixed at creation. html is finished markup you provide, optionally personalized with Liquid.
EmailTemplateThemeFilter
string
Filter by the visual theme a built-in template is designed in. Only built-in system templates have a theme, so naming one returns built-ins alone.
EmailTemplateTheme
string
The visual theme a built-in template is designed in. Each of the catalog's five themes ships its own set of eight emails, and the sets overlap only partly, so…
EmailTemplateLanguageState
object
Where one of the template's languages stands: whether sends are using it, and whether its draft contains an unpublished edit.
2 properties
1 required
EmailTemplateSummary
object
20 properties
20 required
EmailTemplateList
EmailTemplateSourceWrite
string
The authoring format to create the template in. html is finished markup you provide, optionally personalized with Liquid; a format the API cannot author yet is…
EmailTemplateLanguageContent
object
One language's content for an email template. Each language carries its own subject, preview text and bodies, so a translation can differ in wording and length…
4 properties
EmailTemplateCreate
object
Parameters for creating an email template and its initial draft.
9 properties
3 required
BrandKitID
string
EmailTemplate
object
22 properties
22 required
EmailTemplateDraftRevision
integer
The draft revision you last read (from the template's revision field). A stale value returns a conflict so you can reload and retry.
EmailTemplateUpdate
object
Partial update of a template's metadata and draft settings. Only the fields you send are changed. The rest are left as-is. Include the draft revision you last…
6 properties
1 required
EmailTemplateDuplicate
object
Optional parameters when duplicating an email template. The body may be omitted entirely to accept the defaults.
1 property
EmailTemplatePreviewContent
object
Content to render instead of the template's stored draft. Give it the subject and bodies you have in hand and they are rendered exactly as the draft would be,…
4 properties
EmailTemplatePreviewRequest
object
Sample values and options for rendering a template preview. Omit the body entirely to preview the current draft: bird.contact. tokens then fill from stand-in v…
5 properties
EmailCompatibilityReportSeverity
string
The worst severity across every finding the response was computed from, which is the authoritative reading: a response that caps how many findings it lists sti…
EmailCompatibilityRuleID
string
Which rule produced a finding. - htmlscript: a tag. - htmleventhandlers: a JavaScript event-handler attribute such as onclick. - htmlembeddedcontent: an , , or…
EmailCompatibilitySeverity
string
What a finding costs you. - problem: the pattern does nothing at all. The client removes the markup, never loads the stylesheet carrying it, or will not operat…
EmailClientFamily
string
Which mail client a finding applies to. A finding's message names at most Apple Mail, Gmail, Outlook, and Yahoo; its unsupportedclients and partialclients name…
EmailClientPlatform
string
Which build of a client family a finding applies to. A family can support a feature in one build and not another, so Gmail on iOS is tracked separately from Gm…
EmailClientSupport
object
One mail client family a finding applies to, and which of that family's platforms.
2 properties
2 required
EmailCompatibilityFinding
object
One pattern in the HTML that mail clients remove, ignore, or render inconsistently.
12 properties
12 required
EmailTemplatePreview
object
A rendered preview of an email template: its subject, HTML, and plain-text bodies with the supplied sample values filled in, ready to display.
7 properties
7 required
EmailTemplateVersionStatus
string
Whether this version is still being edited or has been published. It records the version's publication history: a version that a later one replaced stays publi…
Actor
object
3 properties
2 required
EmailTemplateVersionSummary
object
One version of a template, without its content. Version history lists every version a template has ever had, and each one has a full copy of the content in eve…
11 properties
8 required
EmailTemplateVersionList
EmailTemplateBroadcastSummary
object
One broadcast that blocks deleting this template.
4 properties
3 required
EmailTemplateBroadcastList
EmailTemplateVersion
object
11 properties
8 required
EmailTemplateLanguageSummary
object
One language of a template version, without its content: enough to list what a version holds and how big each language is. Read a single language to get its co…
6 properties
2 required
EmailTemplateLanguageList
object
1 property
1 required
EmailTemplateLanguage
object
One language of a template version: its content plus the identity a concurrent-edit check needs. Reading a language returns everything you need to edit it and…
7 properties
4 required
EmailTemplateLanguageUpsert
object
Content to save for one language, replacing whatever that language held. Send every field you want the language to keep: a field you omit is cleared, which is…
5 properties
1 required
EmailTemplateRef
string
The template this call addressed, as its id, even when you addressed it by slug. Send it back as templateref on a follow-up call.
EmailTemplateLanguageSaved
object
The identity, revision counters, and fingerprint of a saved language. The response does not include its content; read the language to retrieve it.
10 properties
7 required
EmailTemplateLanguageUpdate
object
A partial edit to one language: send only the fields you are changing, and the rest keep their current values. The language must already exist. Create it by sa…
5 properties
EmailTemplateRollback
object
Parameters for rolling a template back to an earlier published version. Rolling back also replaces the draft with that version's content, so you have to pass r…
1 property
1 required
EmailTemplateSubmit
object
Options for a submit. Every field here is optional, so an empty request body submits the draft exactly as it stands.
3 properties
EmailTemplateSubmitProblem
object
One problem found while checking whether a version can be submitted.
4 properties
2 required
EmailTemplateSubmitResult
object
The outcome of a submit. This has the same shape whether the submit was a validation run or a real one, so you can read valid and version the same way either t…
7 properties
6 required
InboundAddressID
string
InboundAddress
object
An email address we create for you, which receives mail on your behalf. Forward a real mailbox (for example, a support inbox) to this address. Every message se…
5 properties
5 required
InboundAddressList
InboundAddressCreate
object
Parameters for minting a new inbound address.
1 property
InboundAddressUpdate
object
Fields to update on an inbound address.
1 property
InboundEmailMessageID
string
InboundAttachmentID
string
InboundAttachment
object
Metadata for a file attached to a received email. The raw bytes are fetched separately with GET /v1/email/inbound-messages/{inboundmessageid}/attachments/{atta…
4 properties
4 required
InboundEmailMessage
object
An email received on your behalf, parsed from the original message. Fetch the body with /body, the original MIME with /raw, and attachment bytes with /attachme…
16 properties
15 required
InboundEmailMessageList
InboundEmailMessageBody
object
The parsed body of a received email.
2 properties
2 required
InboundAttachmentList
object
The attachments on a received email. The response returns every attachment without pagination.
1 property
1 required
MailboxID
string
MailboxOwner
object
The principal that owns the mailbox. Always the workspace.
2 properties
2 required
Mailbox
object
A durable mailbox identity for an agent. A mailbox owns an email address, groups mail into threads, applies receive policy, and remembers message metadata, ext…
19 properties
17 required
MailboxList
MailboxCreate
object
Parameters for creating a mailbox.
7 properties
MailboxUpdate
object
Fields to update on a mailbox. Omitted fields are unchanged. Fields set to null are cleared. The address and domain are immutable.
5 properties
MailboxStatsSummary
object
Single-row aggregate of the mailbox's email activity across the full requested period. Counts are sums of per-bucket counts across the window. Latency percenti…
5 properties
5 required
MailboxStatsPoint
object
Per-mailbox email activity for one time bucket, bucketed by event time. Sent-mail metrics use the same delivery, engagement, and latency breakdowns as the emai…
6 properties
6 required
MailboxStatsResponse
object
A mailbox's sent and received email statistics: a period-wide summary plus a bucketed time series. period echoes the range and grain actually used. data is one…
3 properties
3 required
ReceiveRuleID
string
ReceiveRule
object
An allow or block entry on a mailbox, evaluated when inbound mail arrives. Matching is against the message's envelope sender; domain entries also match subdoma…
7 properties
7 required
ReceiveRuleList
ReceiveRuleCreate
object
Parameters for adding a receive rule to a mailbox.
3 properties
2 required
EmailInboundRouteID
string
InboundRoute
object
A routing rule that directs inbound mail on one of your domains into a mailbox, or drops it. Routes are tried in priority order, lowest number first. Each mail…
10 properties
10 required
InboundRouteList
InboundRouteCreate
object
Parameters for creating an inbound route.
7 properties
3 required
InboundRouteUpdate
object
Fields to update on an inbound route. Omitted fields are unchanged. The domain is immutable.
6 properties
ThreadID
string
EmailThreadHighlights
object
Matched search fragments for a thread, one array per field the query matched, with the matched terms wrapped in . A field is present only when the query matche…
2 properties
EmailThread
object
A conversation in a mailbox. It groups every message in both directions, the mail the mailbox received and the replies it sent, and it holds the conversation's…
14 properties
13 required
EmailThreadList
EmailLabelsUpdate
object
Label changes to apply. Labels in add are applied and labels in remove are taken off; other labels are left untouched. Adding a label that is already present,…
2 properties
EmailThreadUpdateRequest
object
Changes to apply to a thread. Omitted fields are left unchanged.
2 properties
EmailThreadMessageRecipient
object
One recipient's terminal delivery outcome on a sent conversation message, recorded once the outcome becomes known.
2 properties
2 required
EmailThreadMessageAttachment
object
Attachment metadata on a conversation message. Both the metadata and the attachment bytes stay available for the mailbox's retention tier.
4 properties
4 required
EmailThreadMessageSource
object
Link to the message's entry in the received-message or sent-message log, which has delivery analytics such as per-recipient events. Log entries expire 30 days…
2 properties
2 required
EmailThreadMessage
object
A message in a mailbox conversation, either direction. Message metadata, extracted text, and attachment bytes stay readable for the mailbox's retention tier. T…
25 properties
24 required
EmailThreadMessageList
EmailThreadMessageUpdateRequest
object
Changes to apply to a conversation message. Omitted fields are left unchanged.
2 properties
EmailThreadMessageBody
object
The original rendered body of a conversation message. Available for 30 days after the message occurred. After that, the endpoint returns 410 Gone, but the mess…
2 properties
2 required
EmailThreadMessageAttachmentList
object
The attachments on a conversation message.
1 property
1 required
EmailThreadMessageReplyRequest
object
A reply to a conversation message. Recipients are derived from the message being replied to: its Reply-To address when present, otherwise its From address. Set…
7 properties
EmailThreadMessageForwardRequest
object
Forwards a conversation message to new recipients. The original body and attachments are sent as they were received or sent, and the subject gains a Fwd: prefi…
5 properties
1 required
EmailMailboxComposeRequest
object
A new message sent from a mailbox, starting a new conversation. Mirrors the plain send request without from, because the mailbox is who the message comes from,…
11 properties
2 required
EmailMailboxLabel
object
One label available in a mailbox.
2 properties
2 required
EmailMailboxLabelList
object
The labels available in a mailbox.
1 property
1 required
EmailSmtpConfig
EmailSmtpConfigList
EmailSmtpConfigUpdate
object
Desired changes to the SMTP config for the key. A field you omit is left unchanged. If no config exists yet for this key, omitted fields take their documented…
5 properties
EmailSmtpConnection
object
5 properties
5 required
EmailSmtpConnectionList
object
3 properties
2 required
WebhookSortField
string
Field to sort webhook endpoints by: createdat (the default; newest first with the default order) or url.
WebhookEndpointID
string
WebhookEventType
string
Webhook event type. This is an open enum, so accept unrecognized values in deliveries. Subscribing to a type outside the event catalog returns a 422.
WebhookEndpointRealtime
object
Realtime app scope for the endpoint. Required when subscribing to a realtime. event and valid only when at least one such event is included. Invalid combinatio…
1 property
1 required
WebhookEndpoint
WebhookEndpointList
WebhookEndpointCreate
object
3 properties
2 required
WebhookEndpointCreated
WebhookEndpointUpdate
object
4 properties
WebhookRotateSecretResponse
object
1 property
1 required
WebhookTestRequest
object
1 property
EventAMBPaymentUpdated
object
An Apple Messages for Business payment changed durable state. Consumers deduplicate by payment id and version and ignore older versions.
3 properties
3 required
EventDomainFailedData
object
Payload of the domain.failed event.
4 properties
3 required
EventDomainFailed
object
A sending domain failed DNS verification.
3 properties
3 required
EventDomainVerifiedData
object
Payload of the domain.verified event.
3 properties
3 required
EventDomainVerified
object
A sending domain completed DNS verification successfully.
3 properties
3 required
EventEmailBase
object
Identity fields shared by every email lifecycle event payload.
8 properties
8 required
EventEmailAcceptedData
object
Payload of the email.accepted event.
EventEmailAccepted
object
The API accepted the email send and is preparing it for delivery. Fires once per requested recipient.
3 properties
3 required
EmailBounceType
string
Bounce classification. - hard: A permanent failure, such as an invalid address or a domain that does not exist. - soft: A transient failure, such as a full mai…
EventEmailBouncedData
object
Payload of the email.bounced event.
EventEmailBounced
object
An outbound email permanently failed at the recipient's mail server. Fires once per recipient.
3 properties
3 required
EventEmailMessageBase
object
Identity fields shared by the message-level email lifecycle events (scheduled, canceled), which are not tied to a single recipient.
4 properties
4 required
EventEmailCanceledData
object
Payload of the email.canceled event.
EventEmailCanceled
object
A scheduled send was canceled before it fired. Fires once for each message regardless of its recipient count.
3 properties
3 required
EventEmailClickedData
object
Payload of the email.clicked event.
EventEmailClicked
object
The recipient clicked a tracked link in the email. May fire more than once per recipient.
3 properties
3 required
EventEmailComplainedData
object
Payload of the email.complained event.
EventEmailComplained
object
The recipient marked the email as spam through their mailbox provider's feedback loop. Fires once per recipient.
3 properties
3 required
EventEmailDeferredData
object
Payload of the email.deferred event.
EventEmailDeferred
object
The recipient's mail server temporarily refused the email. Delivery remains pending and is retried. May fire more than once per recipient.
3 properties
3 required
EventEmailDeliveredData
object
Payload of the email.delivered event.
EventEmailDelivered
object
An outbound email reached the recipient's mail server and was accepted.
3 properties
3 required
EventEmailListUnsubscribedData
object
Payload of the email.listunsubscribed event.
EventEmailListUnsubscribed
object
Recipient unsubscribed via the RFC 8058 one-click List-Unsubscribe mechanism. Fires once per recipient.
3 properties
3 required
EventEmailOpenedData
object
Payload of the email.opened event.
EventEmailOpened
object
The recipient opened the email (the tracking pixel was loaded). May fire more than once per recipient.
3 properties
3 required
EventEmailOutOfBandBounceData
object
Payload of the email.outofbandbounce event.
EventEmailOutOfBandBounce
object
A bounce notification arrived after the message had already been accepted for delivery. Fires once per recipient.
3 properties
3 required
EventEmailProcessedData
object
Payload of the email.processed event.
EventEmailProcessed
object
The API prepared the message for delivery to the recipient's mail server. Fires once per recipient.
3 properties
3 required
EventEmailReceivedData
object
Payload of the email.received event.
12 properties
6 required
EventEmailReceived
object
The API received and parsed an inbound email. The payload carries the message's identifiers, sender and recipients, subject, threading reference, and authentic…
3 properties
3 required
EmailRejectionReason
string
Why an email was rejected before delivery. - recipientsuppressed: The recipient is on the workspace suppression list, so delivery was never attempted. - transm…
EventEmailRejectedData
object
Payload of the email.rejected event.
EventEmailRejected
object
The API rejected the email before delivery because of suppression, transmission failure, content, or policy. Fires once per recipient.
3 properties
3 required
EventEmailScheduledData
object
Payload of the email.scheduled event.
EventEmailScheduled
object
The API accepted an email scheduled for a future time. Fires once per message when the schedule is created.
3 properties
3 required
EventEmailUnsubscribedData
object
Payload of the email.unsubscribed event.
EventEmailUnsubscribed
object
Recipient unsubscribed by clicking a tracked unsubscribe link in the email. Fires once per recipient.
3 properties
3 required
EventEmailMailboxMessageDeliveredData
object
Payload of the emailmailbox.messagedelivered event.
3 properties
3 required
EventEmailMailboxMessageDelivered
object
Every recipient of a mailbox message reached a delivered state. This event fires once per message. The same send also emits one email.delivered event for each…
3 properties
3 required
EventEmailMailboxMessageFailedData
object
Payload of the emailmailbox.messagefailed event.
4 properties
4 required
EventEmailMailboxMessageFailed
object
A mailbox message reached a terminal delivery failure. This event fires once per message. The same send also emits per-recipient email. events. Choose one even…
3 properties
3 required
EventEmailMailboxMessageReceivedData
object
Identifiers, threading details, authentication results, and extracted text for a received mailbox message. The thread-message endpoints provide the original so…
14 properties
7 required
EventEmailMailboxMessageReceived
object
An email arrived in a mailbox. The same message also emits an email.received event. The two events can arrive in either order. Choose one event family for each…
3 properties
3 required
EventEmailMailboxMessageSentData
object
Payload of the emailmailbox.messagesent event.
3 properties
3 required
EventEmailMailboxMessageSent
object
A mailbox message was handed off for delivery. This event fires once per message. The same send also emits per-recipient email. events. Choose one event family…
3 properties
3 required
EventEmailMailboxSuspendedData
object
Payload of the emailmailbox.suspended event.
2 properties
2 required
EventEmailMailboxSuspended
object
This mailbox-suspension event is reserved and is not currently emitted.
3 properties
3 required
EventEmailMailboxThreadCreatedData
object
Payload of the emailmailbox.threadcreated event.
4 properties
4 required
EventEmailMailboxThreadCreated
object
A new thread was created in a mailbox, from either direction.
3 properties
3 required
EventEmailSuppressionCreatedData
object
Payload of the emailsuppression.created event.
4 properties
4 required
EventEmailSuppressionCreated
object
An email address was added to the workspace's suppression list (manually, via complaint, or via hard bounce).
3 properties
3 required
EsimID
string
EventEsimBase
object
Identity fields shared by every eSIM lifecycle event payload.
5 properties
5 required
EsimDeliveryChannel
string
Channel the install credentials are delivered over.
EsimDeliveryID
string
EventEsimCredentialsDeliveredData
object
Payload of the esim.credentials.delivered event.
EventEsimCredentialsDelivered
object
Install credentials were delivered to the traveler over the requested channel.
3 properties
3 required
EventEsimCredentialsDeliveryFailedData
object
Payload of the esim.credentials.deliveryfailed event.
EventEsimCredentialsDeliveryFailed
object
Delivering install credentials to the traveler failed.
3 properties
3 required
EventEsimExpiredData
object
Payload of the esim.expired event.
EventEsimExpired
object
The eSIM expired: no data package has been usable for the expiry window. Not terminal: a completed top-up returns it to active, so the event can recur per eSIM.
3 properties
3 required
EsimFailureStage
string
Which stage of the eSIM's lifecycle failed. - provisioning: the eSIM could not be created; its status is failed and nothing was charged. - installation: the eS…
EventEsimFailedData
object
Payload of the esim.failed event.
EventEsimFailed
object
A stage of the eSIM's lifecycle failed. The payload's stage field says whether provisioning failed (the eSIM is dead, nothing was charged) or an installation a…
3 properties
3 required
EventEsimInstalledData
object
Payload of the esim.installed event.
EventEsimInstalled
object
The eSIM profile was installed on the end user's device.
3 properties
3 required
EsimLifecycleOperation
string
The accepted lifecycle change that failed to apply.
EsimPackageID
string
EventEsimOperationFailedData
object
Payload of the esim.operationfailed event.
EventEsimOperationFailed
object
An accepted lifecycle change was definitively rejected by the mobile network. The resource has returned to the status it held before the change was accepted.
3 properties
3 required
EsimOrderID
string
EsimOfferID
string
EventEsimOrderCompletedData
object
Payload of the esim.order.completed event.
5 properties
5 required
EventEsimOrderCompleted
object
An eSIM order completed. The order names the eSIM and data package it produced.
3 properties
3 required
EventEsimOrderFailedData
object
Payload of the esim.order.failed event.
6 properties
6 required
EventEsimOrderFailed
object
An eSIM order failed. Any charge for it has been credited back.
3 properties
3 required
EventEsimPackageBalanceLowData
object
Payload of the esim.package.balancelow event.
EventEsimPackageBalanceLow
object
Fires once, when a data package's remaining balance first drops below its low-balance threshold, 20% of the package's total data. A package's balance only ever…
3 properties
3 required
EventEsimPackageDepletedData
object
Payload of the esim.package.depleted event.
EventEsimPackageDepleted
object
A data package's balance is fully used. The eSIM cannot consume data from this package anymore, even if validity remains.
3 properties
3 required
EventEsimPackageExpiredData
object
Payload of the esim.package.expired event.
EventEsimPackageExpired
object
A data package's validity period ended. Any unused balance expired with it.
3 properties
3 required
EventEsimPackageReadyData
object
Payload of the esim.package.ready event.
EventEsimPackageReady
object
A data package was confirmed on the eSIM and is ready to use in its coverage zone.
3 properties
3 required
EventEsimPackageRemovedData
object
Payload of the esim.package.removed event.
EventEsimPackageRemoved
object
A data package was removed from the eSIM and its zone slot is free again.
3 properties
3 required
EventEsimReadyData
object
Payload of the esim.ready event.
EventEsimReady
object
The initial data package finished provisioning and the eSIM is ready to install and use.
3 properties
3 required
EventEsimReleasedData
object
Payload of the esim.released event.
EventEsimReleased
object
The eSIM was permanently released. It can never be used again.
3 properties
3 required
EventEsimResumedData
object
Payload of the esim.resumed event.
EventEsimResumed
object
The eSIM was resumed and can use data again.
3 properties
3 required
EventEsimSuspendedData
object
Payload of the esim.suspended event.
EventEsimSuspended
object
The eSIM was suspended and can no longer use data until resumed.
3 properties
3 required
PreferenceDeletedEventType
string
Always preference.deleted for this event.
EventPreferenceBase
object
Identity fields shared by every preference lifecycle event: the key plus the ledger entry the write appended. effectiveat is not repeated here: it is the envel…
8 properties
8 required
EventPreferenceDeletedData
object
Payload of the preference.deleted event.
EventPreferenceDeleted
object
A stated preference was deleted, superseding it in the ledger without erasing its history.
3 properties
3 required
PreferenceGrantedEventType
string
Always preference.granted for this event.
EventPreferenceGrantedData
object
Payload of the preference.granted event.
EventPreferenceGranted
object
A stated preference was granted (a person consented, or a customer wrote a grant) and became the key's live statement.
3 properties
3 required
PreferenceRevokedEventType
string
Always preference.revoked for this event.
EventPreferenceRevokedData
object
Payload of the preference.revoked event.
EventPreferenceRevoked
object
A stated preference was revoked (a person opted out, or a customer wrote a revoke) and became the key's live statement.
3 properties
3 required
EventSMSBase
object
Identity fields shared by every SMS lifecycle event payload.
12 properties
11 required
EventSMSAcceptedData
object
Payload of the sms.accepted event.
EventSMSAccepted
object
The API accepted the SMS send request and queued it for processing.
3 properties
3 required
EventSMSDeliveredData
object
Payload of the sms.delivered event.
EventSMSDelivered
object
The carrier confirmed delivery of the message to the recipient handset.
3 properties
3 required
EventSMSExpiredData
object
Payload of the sms.expired event.
EventSMSExpired
object
The message's validity period elapsed before it could be delivered.
3 properties
3 required
EventSMSFailedData
object
Payload of the sms.failed event.
EventSMSFailed
object
Message delivery failed permanently.
3 properties
3 required
SMSReceivedEventType
string
Always sms.received for this event.
EventSMSReceivedData
object
Payload of the sms.received event.
EventSMSReceived
object
A message was received on one of your numbers.
3 properties
3 required
EventSMSRejectedData
object
Payload of the sms.rejected event.
EventSMSRejected
object
The API rejected the message before sending it to the carrier because of an invalid destination, suppression, or content or policy restriction.
3 properties
3 required
EventSMSSentData
object
Payload of the sms.sent event.
EventSMSSent
object
The API handed the message to the carrier for delivery.
3 properties
3 required
EventSMSTfnVerificationBase
object
Identity fields shared by every toll-free verification event payload.
4 properties
4 required
EventSMSTfnVerificationApprovedData
object
Payload of the sms.tfnverification.approved event.
EventSMSTfnVerificationApproved
object
The carrier approved a toll-free number verification; the number can now send in its licensed countries.
3 properties
3 required
EventSMSTfnVerificationInfoRequestedData
object
Payload of the sms.tfnverification.inforequested event.
EventSMSTfnVerificationInfoRequested
object
The carrier requested more information before deciding a toll-free number verification.
3 properties
3 required
EventSMSTfnVerificationRejectedData
object
Payload of the sms.tfnverification.rejected event.
EventSMSTfnVerificationRejected
object
The carrier rejected a toll-free number verification; the number cannot send until an accepted verification is approved.
3 properties
3 required
EventSMSTfnVerificationSubmittedData
object
Payload of the sms.tfnverification.submitted event.
EventSMSTfnVerificationSubmitted
object
A toll-free number verification was submitted to the carrier for review.
3 properties
3 required
EventSMSUndeliveredData
object
Payload of the sms.undelivered event.
EventSMSUndelivered
object
The carrier reported a non-permanent failure to deliver the message.
3 properties
3 required
SMSSuppressionCreatedEventType
string
Always smssuppression.created for this event.
EventSMSSuppressionCreatedData
object
Payload of the smssuppression.created event.
5 properties
5 required
EventSMSSuppressionCreated
object
A destination was added to the workspace's SMS suppression ledger: a subscriber's STOP, a carrier opt-out, or a manual add.
3 properties
3 required
EventVerifyBase
object
Identity fields shared by every Verify lifecycle event payload.
4 properties
4 required
EventVerifyAttemptDeliveredData
object
Payload of the verify.attempt.delivered event.
EventVerifyAttemptDelivered
object
The channel confirmed delivery of a one-time passcode to the recipient.
3 properties
3 required
EventVerifyAttemptSentData
object
Payload of the verify.attempt.sent event.
EventVerifyAttemptSent
object
A one-time passcode was dispatched to the recipient on a channel.
3 properties
3 required
EventVerifyAttemptUndeliveredData
object
Payload of the verify.attempt.undelivered event.
EventVerifyAttemptUndelivered
object
A one-time passcode failed to deliver to the recipient.
3 properties
3 required
EventVerifyVerificationCreatedData
object
Payload of the verify.verification.created event.
EventVerifyVerificationCreated
object
A verification session was created and its first one-time passcode is being sent.
3 properties
3 required
VerifyVerificationFailedEventType
string
Always verify.verification.failed for this event.
EventVerifyVerificationFailedData
object
Payload of the verify.verification.failed event.
EventVerifyVerificationFailed
object
The verification ended without the recipient receiving a passcode: every planned channel reported that its send would not arrive.
3 properties
3 required
EventVerifyVerificationVerifiedData
object
Payload of the verify.verification.verified event.
EventVerifyVerificationVerified
object
The verification was successfully resolved: the recipient confirmed the correct code.
3 properties
3 required
VoiceCallID
string
VoiceSessionID
string
VoiceCallDirection
string
Whether the call originated from your PBX (outbound) or arrived from a remote party (inbound).
EventVoiceBase
object
Identity fields shared by every voice call lifecycle event payload.
6 properties
5 required
EventVoiceCallAnsweredData
object
Payload of the voicecall.answered event.
EventVoiceCallAnswered
object
The called party answered and media began flowing.
3 properties
3 required
VoiceCallStatus
string
Call status. A call that has ended carries one of: - answered means it connected and the far end picked up. - noanswer means nobody picked up before the call t…
EventVoiceCallEndedData
object
Payload of the voicecall.ended event.
EventVoiceCallEnded
object
The call ended after either party hung up or call setup failed.
3 properties
3 required
EventVoiceCallInitiatedData
object
Payload of the voicecall.initiated event.
EventVoiceCallInitiated
object
Call routing began.
3 properties
3 required
EventWhatsAppBase
object
Identity fields shared by every WhatsApp lifecycle event payload.
8 properties
7 required
EventWhatsAppAcceptedData
object
Payload of the whatsapp.accepted event.
EventWhatsAppAccepted
object
The API accepted and charged the send request.
3 properties
3 required
WhatsAppAgentDeliveredEventType
string
Always whatsapp.agent.delivered for this event.
EventWhatsAppDeliveredData
object
Payload of the whatsapp.delivered event.
EventWhatsAppAgentDelivered
object
A message the business agent sent was delivered to the contact's device.
3 properties
3 required
WhatsAppAgentHandedOffEventType
string
Always whatsapp.agent.handedoff for this event.
EventWhatsAppAgentHandedOffData
object
Payload of the whatsapp.agent.handedoff event.
6 properties
6 required
EventWhatsAppAgentHandedOff
object
A contact's conversation changed hands between the agent and your own application.
3 properties
3 required
WhatsAppAgentReadEventType
string
Always whatsapp.agent.read for this event.
EventWhatsAppReadData
object
Payload of the whatsapp.read event.
EventWhatsAppAgentRead
object
The contact read a message the business agent sent.
3 properties
3 required
WhatsAppAgentReceivedEventType
string
Always whatsapp.agent.received for this event.
EventWhatsAppReceivedData
object
Payload of the whatsapp.received event. Carries the message's content so a subscriber can act on it without reading the message back.
EventWhatsAppAgentReceived
object
A contact wrote to a number while the business agent held their conversation. The agent answers this message; your application does not. Messages that arrive w…
3 properties
3 required
WhatsAppAgentSentEventType
string
Always whatsapp.agent.sent for this event.
EventWhatsAppSentData
object
Payload of the whatsapp.sent event.
EventWhatsAppAgentSent
object
The business agent sent a message to a contact on your number. It is a message your workspace did not compose, so it is reported apart from whatsapp.sent.
3 properties
3 required
EventWhatsAppDelivered
object
The message was delivered to the recipient's device.
3 properties
3 required
EventWhatsAppFailedData
object
Payload of the whatsapp.failed event.
EventWhatsAppFailed
object
Message delivery failed permanently.
3 properties
3 required
WhatsAppReactedEventType
string
Always whatsapp.reacted for this event.
EventWhatsAppReactedData
object
Payload of the whatsapp.reacted event. Names the message the contact reacted to, not the reaction, because a reaction is an annotation on a message rather than…
5 properties
5 required
EventWhatsAppReacted
object
A contact placed, changed or took back a reaction on a message.
3 properties
3 required
EventWhatsAppRead
object
The recipient read the message.
3 properties
3 required
WhatsAppReceivedEventType
string
Event type.
EventWhatsAppReceived
object
A contact sent the business a WhatsApp message.
3 properties
3 required
EventWhatsAppRejectedData
object
Payload of the whatsapp.rejected event.
EventWhatsAppRejected
object
The API rejected the message before sending it to WhatsApp because the recipient is on the workspace suppression list, the wallet has insufficient balance, or…
3 properties
3 required
EventWhatsAppSent
object
The API handed the message to Meta for delivery.
3 properties
3 required
WhatsAppSuppressionCreatedEventType
string
Always whatsappsuppression.created for this event.
EventWhatsAppSuppressionCreatedData
object
Payload of the whatsappsuppression.created event.
5 properties
5 required
EventWhatsAppSuppressionCreated
object
An address was added to the workspace's WhatsApp suppression ledger.
3 properties
3 required
WebhookTestResponse
object
6 properties
3 required
WebhookReplayRequest
object
2 properties
WebhookEventID
string
WebhookAttempt
object
9 properties
7 required
WebhookAttemptList
object
1 property
1 required
RequestID
string
LogEntryBase
object
Fields common to audit and request log entries.
11 properties
7 required
AuditEventID
string
AuditLogTarget
object
3 properties
2 required
AuditLogWorkspace
object
The workspace the action was performed in, if applicable.
2 properties
1 required
AuditLogOrg
object
The organization the action was performed in.
2 properties
1 required
AuditLogFields
object
Audit-specific fields of a log entry.
7 properties
3 required
AuditLogEntry
object
A single audit log entry as returned in list responses (without bodies).
AuditLogEntryList
AuditLogExport
LogEntryBodies
object
Captured request and response bodies. Returned only on the single-entry endpoints. List responses omit them.
2 properties
AuditLogEntryDetail
object
A single audit log entry with the captured request and response bodies.
RequestLogFields
object
Request-log-specific fields of a log entry.
3 properties
1 required
RequestLogEntry
object
A single request log entry as returned in list responses (without bodies).
RequestLogEntryList
RequestLogHistogramPoint
object
3 properties
3 required
RequestLogHistogramResponse
object
1 property
1 required
RequestLogBodyMeta
object
Size and content-type metadata for the captured request and response bodies. Returned only when fetching a single request log entry.
6 properties
RequestLogEntryDetail
object
A single request log entry with the captured request and response bodies.
AccessRestrictionID
string
AccessRestrictionAppliesTo
object
Targeting selector for the rule. A rule fires only when the incoming request's scope, level, and principal type match. Empty arrays mean "match all" for that d…
3 properties
AccessRestrictionIPAllowlistParameters
object
3 properties
2 required
AccessRestrictionEffect
string
What happens when the rule matches. deny blocks the request. allow permits it (useful for allowlist exceptions).
AccessRestrictionMode
string
Evaluation behavior. - enforcing: actively allows or denies requests. - shadow: logs and observes but never blocks. - disabled: deactivates the rule without de…
AccessRestriction
object
15 properties
11 required
AccessRestrictionList
AccessRestrictionCreate
object
11 properties
4 required
AccessRestrictionUpdate
object
9 properties
SSOSettings
object
The organization's single sign-on settings: the endpoints an administrator registers with their identity provider, and whether single sign-on is required. The…
2 properties
2 required
SSOEnforcementUpdate
object
Turn the organization's single sign-on requirement on or off.
1 property
1 required
SSODomainStatus
string
Verification state of a domain claim. - pending: the DNS TXT record has not yet been found. - verified: the DNS TXT record has been found. - suspended: a previ…
SSODomainDNSRecord
object
The DNS TXT record to publish to prove ownership of the domain.
3 properties
3 required
SSOVerifiedDomain
object
A domain claimed for single sign-on, and the DNS record that proves the claim. Only a verified claim is exclusive: while your organization holds one, no other…
7 properties
6 required
SSOVerifiedDomainList
object
1 property
1 required
SSOVerifiedDomainCreate
object
1 property
1 required
SSOConnectionStatus
string
Lifecycle state of a connection. - draft: configured but not yet serving logins. - active: serves logins, and requires your organization to hold at least one v…
SSOConnectionOIDCConfig
object
Non-secret OIDC configuration for a connection. The client secret is never returned.
9 properties
8 required
SSONameIDFormat
string
SAML NameID format used as the member's permanent identity key. Assertions with a different format are rejected. Omitting it resolves the format from your iden…
SSOConnectionSAMLConfig
object
SAML configuration for a connection, resolved from metadata and any directly provided fields.
7 properties
4 required
SSOConnectionSAMLSP
object
The values to register with your identity provider for this connection. Every one is derived from the connection's own ID and none depends on the identity prov…
4 properties
4 required
SSOIdPConnection
object
An identity-provider connection: what members see on the sign-in button, what a first sign-in grants them, and the protocol details to register at the provider…
12 properties
7 required
SSOIdPConnectionList
object
1 property
1 required
SSOIdPConnectionOIDCCreate
object
OIDC configuration for a new connection.
6 properties
3 required
SSOIdPConnectionSAMLCreate
object
SAML configuration for a new connection. Supply the identity provider's metadata URL to resolve the entity ID, sign-in URL, and signing certificates from it; a…
8 properties
SSOIdPConnectionCreate
object
Create an identity-provider connection. Provide exactly one of oidc or saml to select the single sign-on protocol.
5 properties
2 required
SSOIdPConnectionUpdate
object
Partially update an SSO connection's branding and JIT settings. Omit a field to leave it unchanged.
5 properties
SSOConnectionSAMLConfigure
object
The identity provider's details for a SAML connection created without them. Supply exactly one of a metadata URL, the metadata document itself, or the entity I…
6 properties
SSOConnectionTestStart
object
Where to send a browser to run a connection test.
1 property
1 required
SSOConnectionStatusTarget
string
The status to move a connection to. A deliberate subset of the connection's own status values: draft is only ever the state a connection is created in, and del…
SSOConnectionStatusUpdate
object
1 property
1 required
SSOConnectionCredentialRotation
object
New credentials for an existing connection. Provide the field that matches the connection's protocol: clientsecret for OIDC, idpx509certs for SAML.
2 properties
TrustDisplayStatus
string
Where a trust requirement stands. - verified: the requirement is met. - inprogress: a verification is being reviewed. - actionrequired: you need to complete a…
TrustGateUnlock
object
A capability that this trust requirement unlocks once it is satisfied.
2 properties
2 required
TrustGateRemediation
object
What happens next for a trust requirement that is not yet verified. This may be a step you take or a review you wait on. Present for every non-verified state.
1 property
1 required
TrustGate
object
A trust requirement and its current state for your organization.
5 properties
5 required
TrustGateList
object
1 property
1 required
EmailVerificationStart
object
Destination for a requirement verified by email.
1 property
1 required
PhoneVerificationStart
object
Destination for a requirement verified by phone.
1 property
1 required
TrustVerificationStart
Optional input for starting a verification. Only used for a requirement verified with a one-time code, where it names the destination the code is sent to; igno…
TrustVerificationLaunch
object
A started verification flow. A requirement verified through a provider-hosted flow returns a hosted URL to redirect the customer to; a requirement verified wit…
4 properties
1 required
TrustVerificationCheck
object
The one-time code sent to complete a verification.
1 property
1 required
TrustAction
string
An action whose trust requirements are enforced. - buynumber: allocate a dedicated phone number. - registersenderid: submit a sender for a country's registrati…
TrustActionGate
object
One trust requirement an action depends on, and where it stands for your organization.
5 properties
5 required
TrustActionRequirements
object
What an action requires of your organization, and how far you have got.
3 properties
3 required
PlatformRoleEnum.gen
string
AdminMe
object
3 properties
3 required
AdminWorkProfileId
string
A personal Admin work profile; selecting one never changes staff permissions.
AdminActiveWorkProfile
The selected work profile, or null to use the staff role default.
AdminPinnedItems
arraynull
Ordered navigation shortcut identifiers. Null uses the role defaults; an empty array keeps the selection empty.
AdminHomeSectionId
string
A supported section of the personal Admin Home.
AdminHomeSections
arraynull
Ordered Home section identifiers. Null uses the role defaults; an empty array keeps the selection empty.
AdminPreferenceProfile
object
3 properties
3 required
AdminPreferences
object
2 properties
2 required
AdminPreferencesUpdate
object
4 properties
AdminCrmObject
string
Attio record collection managed by the CRM workbench.
AdminCrmIdentifier
string
External Attio identifier; this is not a Bird TypeID.
AdminCrmAttribute
object
Current Attio attribute definition. Only fields that can be edited in the workbench are marked writable.
9 properties
9 required
AdminCrmAttributeList
object
Current non-archived attributes in Attio display order.
1 property
1 required
AdminCrmAttributeOption
object
An existing Attio select option or status.
2 properties
2 required
AdminCrmAttributeOptionList
object
Available choices for an Attio field.
1 property
1 required
AdminCrmFieldValue
object
A field value from Attio, retaining its label and any explicit reference or currency.
6 properties
6 required
AdminCrmRecordField
object
Values for one Attio attribute.
2 properties
2 required
AdminCrmRecord
object
Company, person or deal projected from Attio, without inferred Bird identity or commercial values.
5 properties
5 required
AdminCrmRecordList
object
A bounded page from Attio. Offset pages can shift when records change; reload from the first page to refresh.
2 properties
2 required
AdminCrmFieldValueInput
object
One typed scalar or reference. The attribute definition determines its format.
4 properties
1 required
AdminCrmRecordFieldInput
object
Replace the values of one editable field. Empty values clear an optional field.
2 properties
2 required
AdminCrmRecordWrite
object
Write only the specified fields. Omitted fields stay unchanged. Required fields must be supplied when creating a record.
1 property
1 required
AdminCrmNote
object
Plain text note recorded on an Attio record.
4 properties
4 required
AdminCrmNoteList
object
A bounded page from Attio. Offset pages can shift when records change; reload from the first page to refresh.
2 properties
2 required
AdminCrmNoteCreate
object
Add a plain text note to an Attio record.
2 properties
2 required
AdminCrmConnectionState
string
available means Attio responded; unconfigured means no server credential; unavailable means Attio could not be reached or authorized.
AdminCrmStatus
object
Connection and standard company schema available to the staff CRM workbench.
6 properties
6 required
AdminCrmCompany
object
Projected standard Attio company fields.
5 properties
5 required
AdminCrmCompanyList
object
A bounded page from Attio. Offset pages can shift when records change; reload from the first page to refresh.
2 properties
2 required
AdminCrmOrganizationLink
object
A Bird organization identifier explicitly recorded in a related Attio Workspace record.
2 properties
2 required
AdminCrmOrganizationLinkList
object
A bounded page from Attio. Offset pages can shift when records change; reload from the first page to refresh.
2 properties
2 required
AdminCrmRecordReference
object
An explicit record relation from Attio.
2 properties
2 required
AdminCrmTask
object
Attio task and its explicit assignees and record relations.
7 properties
7 required
AdminCrmTaskList
object
A bounded page from Attio. Offset pages can shift when records change; reload from the first page to refresh.
2 properties
2 required
AdminCrmTaskCreate
object
Create an Attio follow-up with explicit assignees and record links.
4 properties
4 required
AdminCrmTaskUpdate
object
Update completion, deadline, assignees or record links. Omitted fields stay unchanged. Task text cannot be edited through Attio.
4 properties
AdminCrmMember
object
Attio member identity for task assignment filters.
3 properties
3 required
AdminCrmMemberList
object
Attio workspace members.
1 property
1 required
AdminSupportProviderTaskStatus
string
AdminSupportWorkbenchAssignee
object
3 properties
3 required
AdminSupportProviderTask
object
Current provider task facts. Empty optional descriptions and references are omitted. Task description input may be empty; omitting description on update preser…
9 properties
6 required
AdminSupportProviderTasks
AdminSupportProviderTaskCreate
object
6 properties
2 required
AdminSupportCommandKey
string
AdminSupportStaffDeliveryState
string
AdminSupportStaffDelivery
object
Durable staff intent. Acknowledged means the provider accepted this mutation; it is not delivery, read, or an exact timeline-entry proof. Unknown results never…
10 properties
7 required
AdminSupportProviderTaskUpdate
object
7 properties
2 required
AdminSupportProviderThreadLink
object
5 properties
2 required
AdminSupportProviderThreadLinks
AdminSupportProviderTaskLinkCreate
object
2 properties
2 required
AdminSupportProviderDiscussion
object
9 properties
4 required
AdminSupportProviderDiscussions
AdminSupportProviderDiscussionChannel
string
AdminSupportProviderDiscussionCreate
object
Explicitly sends the exact opening text to the selected provider destination. Requires verified integration capability and an authorized destination. Never imp…
6 properties
3 required
AdminSupportProviderDiscussionMessage
object
5 properties
3 required
AdminSupportProviderDiscussionMessages
AdminSupportProviderDiscussionReply
object
6 properties
3 required
AdminSupportWorkbenchSource
string
live reads and writes Plain; demo uses an isolated development fixture.
AdminSupportProviderActor
object
Provider actor responsible for a status change. Staff identities are returned for human and machine users; other actor kinds may have no identity.
3 properties
1 required
AdminSupportSLAObjective
object
6 properties
AdminSupportProviderStatusFacts
object
Point-in-time provider facts. Missing SLA objectives are unavailable or not configured; Bird waiting party and due commitments are independent.
6 properties
1 required
AdminSupportWorkbenchStatus
string
TODO needs staff attention; SNOOZED waits until its timer expires or activity arrives; DONE means finished for now and reopens on new activity.
AdminSupportWorkbenchLabelType
object
4 properties
4 required
AdminSupportWorkbenchLabel
object
2 properties
2 required
AdminSupportWorkbenchThread
object
18 properties
15 required
AdminSupportWorkbenchThreadList
AdminSupportProviderThreadLinkType
string
AdminSupportProviderThreadLinkCreate
object
MERGEDINTO marks the source Plain thread done. It does not complete Bird work or prove customer recovery. Both sources must remain authorized in the same verif…
3 properties
3 required
AdminSupportDiscussionCapabilities
object
4 properties
3 required
SupportWorkItemID
string
AdminSupportWorkItemReturn
object
2 properties
2 required
SupportCaseID
string
AdminSupportWorkKind
string
SupportCaseTargetID
string
AdminSupportWorkStatus
string
AdminSupportWorkItem
AdminSupportPublicationCreate
object
2 properties
2 required
AdminSupportPublicationPreview
object
Exact signed outgoing text is returned only while its original retention deadline permits. Preparing does not send. Confirming the displayed immutable preview…
7 properties
6 required
AdminSupportPublishedCommitment
object
Exact published snapshot tied to a provider entry and a frozen reviewed message. Internal rescheduling never updates this snapshot; only an explicitly confirme…
7 properties
7 required
AdminSupportPublishedCommitmentResult
object
1 property
AdminSupportOwner
object
2 properties
2 required
AdminSupportOwnerList
AdminSupportCommandOperation
string
Original coordination operation associated with the command key.
AdminSupportCommandRecoveryInput
object
3 properties
1 required
AdminSupportCommandRecoveryStatus
string
committed returns the original receipt; notdispatched permanently prevents the original command from committing.
AdminSupportCommandReceiptStatus
string
SupportArtifactID
string
AdminSupportCommandReceipt
object
9 properties
3 required
AdminSupportCommandRecovery
object
2 properties
1 required
AdminSupportScopeTargetReference
object
2 properties
2 required
AdminSupportScopeWorkReference
object
2 properties
2 required
AdminSupportScopePreview
object
10 properties
7 required
AdminSupportScopeReconciliation
object
3 properties
3 required
SupportCaseScopeID
string
AdminSupportObservationTime
string
Response calculation observation time. Reads are not one atomic snapshot and do not establish freshness or completeness of Plain provider data.
AdminSupportWorkSummary
object
Counts cover stored Bird obligations, not a Plain-wide queue. Each count intersects every supplied filter and is read separately.
5 properties
5 required
AdminSupportWaitingOn
string
AdminSupportCaseState
string
AdminSupportDomainOutcome
string
AdminSupportCaseOutcome
string
Recorded customer outcome, independent of Plain status and product verification. Outcomes retain their distinct meaning; only verifiedrecovery requires current…
AdminSupportTargetPlatform
string
AdminSupportCaseTarget
AdminSupportCase
AdminSupportOperationsReport
string
Support coordination report to retrieve.
AdminSupportOperationsWorkItem
object
Current work and retained deadline, handoff and return evidence. Metrics do not establish customer delivery or product recovery.
14 properties
6 required
AdminSupportOperationsWindow
object
2 properties
2 required
AdminSupportOperationsWorkItemList
AdminSupportOperationsWorkload
object
Current team and owner workload across accessible retained cases. The group identifier is its oldest unfinished work item and may change as work closes.
9 properties
7 required
AdminSupportOperationsWorkloadList
SupportHistoryID
string
AdminSupportOperationsOutcome
object
Immutable case resolution report. Reopening a case preserves its earlier resolutions; a support resolution alone does not establish product recovery.
10 properties
7 required
AdminSupportOperationsOutcomeList
AdminSupportSpecialistHandoff
object
13 properties
5 required
AdminSupportSpecialistHandoffList
AdminSupportSpecialistHistoryEntry
object
6 properties
5 required
AdminSupportSpecialistHistoryList
AdminSupportSpecialistTransitionStatus
string
AdminSupportSpecialistTransition
object
4 properties
2 required
AdminSupportSpecialistCommandStatus
string
AdminSupportSpecialistCommandResult
object
2 properties
1 required
AdminSupportCaseList
AdminSupportCaseTargetCreate
object
An affected target. newbird requires workspaceid. resourcetype and resourceid must be supplied together. Workspace scope verification does not establish produc…
6 properties
3 required
AdminSupportCaseCreate
object
Find or create by exact authorized Plain thread. An existing case is returned without applying the submitted brief or creating another target. Organization is…
7 properties
5 required
AdminSupportCaseClearField
string
AdminSupportCaseUpdate
object
Patch the supplied fields only. Omission preserves existing values; clearfields intentionally removes supported optional values.
9 properties
2 required
AdminSupportCaseResolution
object
5 properties
4 required
AdminSupportCaseReopening
object
3 properties
3 required
AdminSupportHistory
object
9 properties
6 required
AdminSupportHistoryList
AdminSupportWorkItemList
AdminSupportWorkItemCreate
object
Create a case-specific obligation. Commitment requires owner, dueat and duetimezone. Team is display context, not provider assignment or authorization.
14 properties
5 required
AdminSupportWorkClearField
string
AdminSupportWorkItemUpdate
object
Patch supplied fields; omit to preserve. Explicit clearfields removes optional values. Changing title, owner, target or dependency invalidates acceptance/compl…
15 properties
1 required
AdminSupportWorkItemAcceptance
object
1 property
1 required
AdminSupportWorkItemCompletion
object
3 properties
2 required
AdminSupportWorkItemCancellation
object
2 properties
2 required
AdminSupportCaseTargetInput
object
An affected target. newbird requires workspaceid. resourcetype and resourceid must be supplied together. Workspace scope verification does not establish produc…
8 properties
3 required
AdminSupportCaseTargetWrite
object
2 properties
2 required
AdminSupportEvidence
object
13 properties
12 required
AdminSupportEvidenceList
AdminSupportEvidenceCreate
object
7 properties
7 required
AdminSupportWorkbenchLabelTypeList
AdminSupportWorkbenchLabelTypeCreate
object
1 property
1 required
AdminSupportWorkbenchSnippet
object
4 properties
4 required
AdminSupportWorkbenchSnippetList
AdminSupportWorkbenchPriorityUpdate
object
1 property
1 required
AdminSupportWorkbenchMutationResult
object
2 properties
2 required
AdminSupportWorkbenchLabelUpdate
object
1 property
1 required
AdminSupportWorkbenchUploadCreate
object
3 properties
3 required
AdminSupportWorkbenchUpload
object
3 properties
3 required
AdminSupportWorkbenchEntryId
string
Exact Plain timeline entry identifier.
AdminSupportWorkbenchDownload
object
1 property
1 required
AdminSupportOverviewPoint
object
2 properties
2 required
AdminSupportOverviewMetric
object
7 properties
3 required
AdminSupportOverview
object
7 properties
6 required
AdminSupportWorkbenchDetail
object
5 properties
2 required
AdminSupportWorkbenchAttachment
object
4 properties
4 required
AdminSupportWorkbenchEntry
object
7 properties
7 required
AdminSupportWorkbenchTimeline
AdminSupportWorkbenchAssigneeList
AdminSupportWorkbenchStatusUpdate
object
2 properties
1 required
AdminSupportWorkbenchAssignmentUpdate
object
1 property
1 required
AdminSupportWorkbenchMessageCreate
object
2 properties
1 required
AdminEmailSuppression
object
One record on a workspace's email suppression list: an address Bird will not send to, why, and what created the record. A record blocks the message categories…
10 properties
10 required
AdminEmailSuppressionList
AdminEmailMessageStatus
string
Aggregate delivery status of an email as staff see it. Every value of the customer-facing status, plus blocked. In flight: - scheduled: The message is queued t…
AdminEmailBlock
object
Why spam enforcement blocked this message. Present only on a message whose status is blocked; null on every other message.
3 properties
2 required
AdminEmailMessage
object
Non-PII summary of a single email, for admin triage. Carries only sender and structural metadata; recipient addresses, the subject, and message content are del…
24 properties
22 required
AdminEmailMessageList
AdminEmailContentEnvelope
object
Identifying details of the email whose content was returned.
5 properties
5 required
AdminEmailContentReveal
object
The rendered body of an email, returned to authorized staff for review.
3 properties
3 required
AdminEmailEvent
object
A single lifecycle event for one recipient of an email, with the full sending diagnostics staff need to debug a delivery. Carries no recipient address, client…
17 properties
4 required
AdminEmailEventList
AdminEmailRecipient
object
Delivery state for one recipient of an email, identified by domain only. Carries the recipient's domain and per-recipient delivery status, never the full addre…
12 properties
6 required
AdminEmailRecipientList
AdminEmailSubjectsRequest
object
The emails to reveal subjects for.
1 property
1 required
AdminEmailSubject
object
The subject line of a single email.
2 properties
2 required
AdminEmailSubjectList
object
Subject lines for the requested emails.
1 property
1 required
AdminEmailSpamVerdict
object
The spam assessment of a single email: an automated score and, when staff have classified the email by hand, that classification. Higher scores mean more spam-…
8 properties
7 required
AdminEmailSpamVerdictList
object
Spam assessments for the requested emails.
1 property
1 required
AdminEmailSpamLabelCreate
object
A staff classification of an email.
1 property
1 required
AdminEmailSpamLabel
object
A recorded staff classification of an email, including whether the spam filter has been taught with it yet.
6 properties
5 required
AdminInboundEmailMessage
object
Non-PII summary of a single received (inbound) email, for admin triage. Carries the external sender, structural recipient counts, and the authentication verdic…
13 properties
13 required
AdminInboundEmailMessageList
AdminMailbox
object
A staff-facing view of one agent mailbox, across tenants. Carries the mailbox's own configuration and counts plus its owning organization and workspace for att…
16 properties
12 required
AdminMailboxList
MailboxReceivePolicy
string
Which inbound mail a mailbox accepts: - open: Accepts everything not blocked by a rule. - repliesonly: Accepts only replies to messages this mailbox has sent.…
MailboxRetentionTier
string
How long message metadata, extracted text, and attachments are kept. Original bodies and inbound raw MIME are limited to 30 days on every tier.
AdminMailboxCreate
object
Parameters for provisioning a mailbox into a customer's workspace on staff authority. The workspace decides which organization owns the mailbox and which regio…
8 properties
1 required
AdminRealtimeWorkspace
object
One workspace using Bird Realtime in this region, with how many apps it holds. Realtime app rows are regional and carry only the workspace, so the owning organ…
6 properties
5 required
AdminRealtimeAdoptionSummary
object
Region-wide Realtime adoption totals, computed over every workspace in the region rather than the returned page, so they stay stable while paging.
2 properties
2 required
AdminRealtimeWorkspaceList
AdminEmailCompetitiveWorkspace
object
One workspace watching competitor brands in this region, with the size and age of its watchlist. The organization travels on the row because the competitor quo…
6 properties
6 required
AdminEmailCompetitiveAdoptionSummary
object
Region-wide Competitive Insights adoption totals, computed over every watchlist in the region rather than the returned page, so they stay stable while paging.…
3 properties
3 required
AdminEmailCompetitiveWorkspaceList
AdminSurfacesClass
string
Restrict counts to query (GET/HEAD) or mutation (all other methods) traffic. Omit to count both. Rows captured before the class field existed count as neither.
AdminEmailCompetitiveUsageSummary
object
Competitive Insights request, error and latency figures for the range, with the tenants that reached it.
5 properties
5 required
AdminEmailCompetitiveUsageBucket
object
One day of Competitive Insights traffic.
4 properties
4 required
AdminEmailCompetitiveUsageOperation
object
One Competitive Insights operation's traffic and health over the range.
4 properties
4 required
AdminEmailCompetitiveUsage
object
One region's Competitive Insights usage over a reporting range: the totals, a daily trend, and a row per operation. Request and error counts come from a pre-ag…
6 properties
6 required
AdminEmailCompetitiveUsageOrg
object
One organization's Competitive Insights traffic over the range.
4 properties
4 required
AdminEmailCompetitiveUsageOrgs
object
One region's Competitive Insights traffic by organization, busiest first. These counts are exact, unlike the totals on the usage read, which are estimated from…
4 properties
4 required
AdminStatsGrain
string
The bucket grain of the series, one of day, hour, or month.
AdminEmailStatsPeriod
object
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
4 properties
3 required
AdminEmailBlockStats
object
Blocked volume for the scope of the containing row (a time bucket, a breakdown dimension, or the whole period). Staff-only: no customer stats surface reports b…
2 properties
1 required
AdminEmailStatsTotals
object
Aggregate totals across the whole window. Each count is the sum of per-bucket distinct counts, so a recipient (or message) active in two buckets contributes on…
5 properties
1 required
AdminEmailStatsPoint
object
Aggregate stats for one time bucket (a UTC calendar day, hour, or month), bucketed by event time. Buckets with no activity are included with zero counts.
6 properties
2 required
AdminEmailStatsResponse
object
Email sending, volume, deliverability, and engagement statistics over time, for one customer organization or platform-wide within a single region. series is on…
4 properties
4 required
AdminEmailStatsByMailboxProviderResponse
object
Per-mailbox-provider breakdown for one customer organization or platform-wide within a single region, ranked by the sort metric (default delivered) descending…
4 properties
4 required
AdminEmailStatsByBounceCodeResponse
object
Per-SMTP-code bounce breakdown for one customer organization or platform-wide within a single region, ranked by the sort metric (default bounced) descending an…
4 properties
4 required
AdminEmailStatsSortMetric
string
Metric to rank an admin breakdown's rows by, applied descending. This is the shared customer sortable-metric set (EmailStatsSortMetric) plus the admin-only blo…
AdminEmailWorkspaceStatsPoint
object
One workspace's traffic within the window. Ranking workspaces against each other is staff-only: it compares senders, which no customer-facing surface may do.
5 properties
5 required
AdminEmailStatsByWorkspaceResponse
object
Per-workspace breakdown for one customer organization or platform-wide within a single region, ranked by the sort metric (default blocked) descending and cappe…
4 properties
4 required
AdminEmailSmtpConnection
AdminEmailSmtpConnectionList
object
1 property
1 required
AdminTopOrganization
object
One organization in the top-senders ranking, with its message volume and delivery rate over the requested window.
5 properties
4 required
AdminTopOrganizationList
object
The organizations sending the most email in a single region over the requested window, ranked by volume. Combine the regions to see a global ranking.
3 properties
3 required
AdminCurrencyTotal
object
A monetary total in a single currency. Totals are reported per currency and never summed across currencies.
3 properties
3 required
AdminChannelInterest
object
Notify-me interest tally for a single not-yet-live dashboard channel.
3 properties
3 required
AdminOverview
object
Platform-wide operator KPIs aggregated from global data. Regional figures (email volume, wallet balances) are fetched separately.
7 properties
7 required
AdminConsistencyLsnWriter
object
The primary write position and the cost of reading it.
3 properties
2 required
AdminConsistencyLsnReader
object
The in-region read replica's applied position and the cost of reading it.
3 properties
2 required
AdminConsistencyLsnDiagnostics
object
A point-in-time replication-consistency probe for one region: the current write and read log positions, the lag between them, and how long a read waited to cat…
7 properties
7 required
AdminGrowthMrr
object
Monthly recurring revenue in a single currency. Annual subscriptions are normalized to a monthly figure; figures are never summed across currencies.
5 properties
5 required
AdminGrowthPlanTier
object
The number of organizations currently subscribed to a single plan tier.
5 properties
4 required
AdminGrowthFunnel
object
Platform-wide activation funnel for the window's signup cohort, by milestone reached. Each stage counts organizations from the same cohort.
7 properties
7 required
AdminGrowthBoardRow
object
One organization on the hot-accounts or enterprise-leads board. Every figure on the row is a precomputed snapshot recomputed hourly, so it can trail live sendi…
17 properties
14 required
AdminGrowthSummary
object
Platform-wide growth metrics for a reporting window — acquisition, revenue, the activation funnel, and the outreach boards. Period figures cover the selected r…
26 properties
26 required
AdminGrowthAccounts
object
A page of the organization leaderboard together with the total number of tracked organizations.
2 properties
2 required
AdminGrowthSparkPoint
object
One bucket of a volume card's daily sparkline.
2 properties
2 required
AdminGrowthEmailCard
object
Email-volume summary for the window, for the responding region.
5 properties
4 required
AdminGrowthVolumeCard
object
Channel-volume summary for the window, for the responding region.
4 properties
4 required
AdminGrowthVerifyCard
object
Verification-session summary for the window, for the responding region. This card counts verification sessions, not messages: the OTP messages a verification s…
4 properties
4 required
AdminGrowthRealtimeCard
object
Realtime usage summary for the window, for the responding region. Realtime publishes into live channels rather than to an address, so there is no delivery outc…
4 properties
4 required
AdminGrowthVolumeBucket
object
One bucket of the per-organization email volume distribution, for estimating the median email volume per organization across regions when a custom range is in…
2 properties
2 required
AdminGrowthWalletTopUpCurrency
object
One currency's wallet top-up aggregates for the window, with the equal-length prior period for deltas. Amounts are never summed across currencies. An organizat…
7 properties
7 required
AdminGrowthWalletTopUpDay
object
One (day, currency) bucket of the wallet top-up chart. Days at the edges of a window that starts or ends mid-day cover only the in-window portion.
4 properties
4 required
AdminGrowthRegional
object
One region's volume, sender, and wallet top-up figures for the window, combined across regions for the platform view.
16 properties
16 required
AdminSurfacesSummary
object
One region's cross-surface usage counts for a reporting range. Counts are returned raw so a platform view sums them across regions and derives the shares after…
10 properties
10 required
AdminSurfacesTimeseriesDimension
string
The dimension usage buckets are broken down by — by surface, by caller (harness), or by driver (agent, human, or programmatic).
AdminSurfacesTimeseriesBucket
object
One time bucket for one dimension value — the request and error counts for that value in that bucket.
4 properties
4 required
AdminSurfacesTimeseries
object
One region's usage buckets over time broken down by the requested dimension, combined across regions for the platform view.
3 properties
3 required
AdminSurfaceName
string
The client surface a request came through — one of dashboard, cli, mcp, sdk-go, sdk-js, sdk-python, or unknown today. An open set: new surfaces may appear over…
AdminSurfacesKeyCount
object
A request count for one dimension value (a surface, caller, or operation), with the error count for the same value.
3 properties
3 required
AdminSurfacesOperations
object
One region's most-used operations for a reporting range, combined across regions for the platform view.
2 properties
2 required
AdminSurfacesOrgRow
object
One organization's usage totals for the range, with its agent-driven share. The organization name is resolved separately by the caller.
4 properties
4 required
AdminSurfacesOrgs
object
One region's organizations ranked by usage, combined across regions for the platform view. Each region returns extra candidates so the merged platform ranking…
2 properties
2 required
AdminSurfacesOrgDetail
object
One organization's usage breakdown for the range in this region — its surface mix, harness mix, and top operations.
7 properties
7 required
AdminChannelInterestUserOrg
object
One organization owned by a user interested in a channel.
2 properties
2 required
AdminChannelInterestUser
object
One user who asked to be notified when an upcoming channel ships.
5 properties
5 required
AdminChannelInterestUserList
AdminChannelInterestDailyPoint
object
The number of users who registered interest in a channel on a single day.
2 properties
2 required
AdminChannelInterestDaily
object
Daily counts of users who registered interest in a channel over the last 30 days.
1 property
1 required
AdminDomain
object
A sending domain with the verification state of a representative organization that claimed it. A registered-but-unclaimed domain has hasgrant set to false, no…
17 properties
7 required
AdminDomainList
object
A page of sending domains together with the total number matching the filters.
2 properties
2 required
AdminDomainEvent
object
A single event in a sending domain's activity log — a registration, a verification status change, or a configuration update — together with the domain it belon…
10 properties
8 required
AdminDomainEventList
object
A page of sending-domain events together with the total number matching the filters.
2 properties
2 required
AdminDomainInboundStatus
string
Status of an inbound (receiving) claim, scoped to what the field hangs on: the domain on AdminDomainDetail, one organization on AdminDomainGrant. notconfigured…
AdminDomainGrant
object
One organization's claim on a sending domain, with its DKIM and DMARC verification detail.
24 properties
10 required
AdminDomainDetail
object
The full admin view of a sending domain — its registry details and every organization grant on it.
9 properties
8 required
AdminDnsObserved
object
An expected DNS record resolved against live DNS and compared to its expected value.
8 properties
7 required
AdminDnsDiagnostic
object
Raw live-resolved result for one entry in the email-relevant probe set, independent of what Bird expects. Surfaces stray or conflicting records (e.g. a pre-exi…
6 properties
5 required
AdminDomainDnsLookup
object
Live DNS resolution for a sending domain, for staff debugging. observed is one entry per expected record (what Bird requires) resolved against live DNS; diagno…
2 properties
2 required
AdminCnameRawVerdict
object
The unmapped result of the check behind a stored CNAME status. Kept because the mapping to a status is lossy: any verdict the mail provider reports that Bird d…
4 properties
2 required
AdminProviderResource
object
One resource at the mail infrastructure provider that backs a sending domain, paired with Bird's stored view of the same thing so a disagreement between them i…
15 properties
6 required
AdminDomainProviderState
object
What the mail infrastructure provider holds for every resource backing a sending domain, read without asking it to re-verify anything. For staff debugging a do…
1 property
1 required
AdminDomainReverifyRequest
object
Selects the single record to re-check at the mail infrastructure provider.
1 property
1 required
AdminDomainReverifyResult
object
One record's state after a provider re-check, including the provider's raw verdict.
8 properties
5 required
AdminBanCategory
string
The policy category a suspension is recorded under. automatedfraudsignal is reserved for suspensions Bird's automated fraud detection made without a more speci…
AdminOrganization
AdminOrganizationStats
object
Operational figures for one organization, included in the admin organization list when requested.
6 properties
6 required
AdminOrganizationListItem
AdminOrganizationList
AdminOrganizationMessageActivity
object
Accepted message activity across email, SMS, WhatsApp, and Apple Messages for Business for one organization.
3 properties
3 required
AdminOrganizationMessageActivityResponse
object
Message activity for a batch of organizations in one region. A channel failure returns an error rather than a partial total.
4 properties
4 required
SystemEmailID
string
AdminSystemEmail
object
12 properties
5 required
AdminSystemEmailList
AdminOrganizationBanRequest
object
3 properties
1 required
AdminBanEvidenceWindow
object
The inclusive date range the evidence covers, anchored on the organization's lastbannedat (never bannedat, which an unban clears) so a reinstated account's evi…
2 properties
2 required
AdminBanEvidenceChannelStatus
string
Outcome of reading this channel's counters for the evidence window. ok: the counters below are populated. notraffic: the read succeeded, but the organization s…
AdminBanEvidenceDimension
object
One row of a channel's destination or error-code breakdown over the evidence window.
2 properties
2 required
AdminBanEvidenceChannel
object
One channel's message-volume counters over the evidence window, plus the read's own status. Every supported channel always gets an entry (see AdminBanEvidence.…
6 properties
4 required
AdminBanEvidenceReviewedMessageChannel
string
The channel the reviewed message was sent on.
AdminBanEvidenceReviewedMessage
object
One message a staff member individually opened before the ban, from the audited content-reveal trail (admin.{email,sms,whatsapp}content.viewed). Records that t…
4 properties
4 required
AdminBanEvidenceActorKind
string
What recorded the ban. admin: a platform admin initiated it. automated: Bird's automated fraud detection (Sift) did. unknown: no ban event was readable in this…
AdminBanEvidenceActor
object
Who or what recorded the ban, resolved from the audit trail's admin.organization.banned event rather than stored on the organization. Because it is read back f…
3 properties
1 required
AdminBanEvidence
object
The dispute-evidence read for an organization's most recent ban: the category and rendered statement, the evidence window, per-channel message counters, and th…
10 properties
9 required
AdminOrganizationRisk
object
An organization's aggregate trust & safety risk scores. Each score ranges from 0 to 1, where higher is riskier, and is null when not computed or unavailable.
4 properties
AdminOrganizationBackgroundCheckSearch
object
One web search the background check ran, reported so a reviewer can see what it looked for.
1 property
1 required
AdminOrganizationBackgroundCheckStatus
string
What an independent source said about a claim. The same scale carries a single check's result and the report's overall verdict. - verified: a source the organi…
AdminOrganizationBackgroundCheckItem
object
One row of a background check: what was checked, against which authority, and what that authority said. A row is sent as soon as its status is known and re-sen…
8 properties
2 required
AdminOrganizationBackgroundCheckSource
object
A page the background check read while researching the organization.
2 properties
1 required
AdminOrganizationBackgroundCheckSources
object
The pages one of the background check's web searches returned.
1 property
1 required
AdminOrganizationBackgroundCheck
object
The verdict of an organization background check, sent once its checks are complete.
2 properties
1 required
AdminOrganizationBackgroundCheckError
object
The terminal event of a background check that could not be produced. It says nothing about the organization: the check did not run, so no verdict follows from…
1 property
1 required
AdminOrganizationBackgroundCheckEvent
One event of a background check's stream. Which shape arrives is named by the event's own type: a searching event carries a query, a sources event the pages th…
BusinessEntityID
string
UpdateAdminOrganizationBusinessEntity
object
Reassigns the organization's invoicing business entity. Changing the entity recomputes the organization's tax treatment and affects which entity issues future…
1 property
1 required
AdminBusinessEntity
object
A Bird legal entity that invoices organizations. Determines the tax treatment and invoice numbering applied to an org's charges.
5 properties
5 required
AdminTaxCategoryRate
object
A single active per-category tax rate resolved for the organization (used when tax is rated per product category, e.g. US sales tax).
5 properties
5 required
AdminTaxProfileHistoryEntry
object
One entry in the organization's tax-profile change history, newest first.
10 properties
7 required
AdminTaxProfile
object
An organization's full tax profile for staff review: the stored profile, the per-category rates currently in effect, and the recent change history.
16 properties
9 required
BillingTaxProfileUpdate
object
Request body for updating the tax profile. The tax country is not set here; it is always derived from the organization's business profile (the billing address…
1 property
AdminOrganizationBillingTerms
object
1 property
1 required
AdminOrganizationBillingTermsUpdate
object
1 property
1 required
DealQuoteID
string
ContractID
string
ContractVersionID
string
AdminContractEffect
string
Effect of the contract at the requested instant. - scheduled means its first version starts later. - inforce means it currently governs the organization. - sup…
AdminContractBillingEffect
string
Whether billing is explicitly governed by an adopted contract. Managed describes ownership, not successful application.
AdminContractVersionKind
string
Reason this contract version was recorded. - initial means the version records the signed agreement. - amendment means the parties changed an existing agreemen…
AdminContractPaymentMode
string
How the organization pays under the contract. prepaid uses an existing balance and has no credit limit. postpaid permits invoiced usage up to the positive cred…
AdminContractCreditLimit
stringnull
Positive credit limit in major currency units for postpaid terms, with up to six decimal places and a maximum of 9223372036854.775807. Larger amounts are rejec…
AdminContractPricingMode
string
Pricing classification of the agreement. fixed supports explicit attachment of agreed usage rate-card versions before adoption. listrelative remains reference-…
AdminContractTerms
object
9 properties
7 required
AdminContractVersion
object
10 properties
9 required
AdminContractSummary
AdminContractSummaryList
AdminContractBillingApplicationStatus
string
Contract credit and payment-term application status. notenabled means no agreement has been adopted; scheduled means adopted terms have not started; pending me…
AdminContractBillingValues
object
3 properties
3 required
AdminContractBillingFailureCode
string
Reason contract pricing, credit or payment terms could not be applied. creditlimittoolow requires funding or settling usage; currencyconversionincomplete requi…
AdminOrganizationBillingStatus
object
13 properties
13 required
ProductID
string
RateCardID
string
RateCardVersionID
string
AdminBillingRateCardStatus
string
Publication lifecycle of a rate card.
AdminContractRateCard
object
5 properties
5 required
AdminContractPricing
object
1 property
1 required
AdminContractPricingUpdate
object
1 property
1 required
AdminContractAmendmentCreate
object
6 properties
4 required
AdminContractAmendment
object
2 properties
2 required
AdminContractTerminationCreate
object
1 property
1 required
DealID
string
AdminContractCreate
object
3 properties
3 required
AdminContractExecutionCreate
object
6 properties
6 required
AdminContractExecutionSource
string
Signing evidence source. The native value identifies historical executions recorded before native signing was retired.
AdminContractExecution
object
11 properties
11 required
AdminContractStatus
string
Agreement status at the requested instant. signed means the agreement has not been terminated. terminated means the agreement ended early.
AdminContract
AdminContractList
AdminContractBillingBlocker
string
A missing wallet prevents comparison. A currency mismatch requires a separate conversion. A credit limit below the current reserved usage minus balance cannot…
AdminContractBillingPreview
object
6 properties
6 required
OrganizationPaymentSettings
object
1 property
1 required
AdminOrganizationWatchlist
object
4 properties
2 required
AdminOrganizationWatchlistUpdate
object
2 properties
1 required
PaymentConsentID
string
PaymentIntentID
string
AdminBillingPaymentConsentLastCharge
object
The most recent charge that succeeded against a saved payment method.
3 properties
3 required
AdminBillingPaymentConsent
object
14 properties
7 required
AdminBillingPaymentConsentList
WalletID
string
ResourceLink
object
A labelled external link attached to a resource. Rendered by clients as-is; the server owns the URL scheme.
3 properties
3 required
AdminBillingPaymentIntentRefundStatus
string
How much of a payment has been refunded: none (nothing refunded), partiallyrefunded (some but not all of the amount refunded), or refunded (fully refunded).
AdminBillingPaymentIntent
object
15 properties
11 required
AdminBillingPaymentIntentList
PaymentRefundID
string
WalletTransactionID
string
AdminBillingPaymentRefund
object
15 properties
9 required
AdminBillingPaymentRefundList
object
1 property
1 required
AdminBillingPaymentRefundCreate
object
3 properties
1 required
AdminPaymentDisputeStatus
string
Dispute status. REQUIRESRESPONSE needs an accept or challenge. CHALLENGED means evidence was submitted. ACCEPTED means the dispute was accepted and the payment…
AdminPaymentDisputeStage
string
Dispute lifecycle stage. RFI is a request for information from the issuer. PRECHARGEBACK is an inquiry before a formal chargeback. CHARGEBACK means a formal ch…
AdminPaymentDisputeEvidenceDocumentKind
string
Where a dispute evidence document came from. ISSUER is the issuing bank's own attachment. GENERATED is a file the provider rendered from Bird's text evidence.…
AdminPaymentDisputeEvidenceDocument
object
One document attached to a dispute, by the issuing bank or by Bird. This is the read side; AdminPaymentDisputeDocument is the bundle a challenge submits.
7 properties
3 required
AdminPaymentDisputeChallengeReason
string
Why Bird is challenging the dispute.
AdminPaymentDisputeCustomerInfo
object
What Bird knows about the cardholder, used to rebut a chargeback.
6 properties
AdminPaymentDisputeChallengeRecord
object
One challenge already filed on a dispute, as the provider reports it back.
9 properties
2 required
AdminPaymentDisputeRefundReason
string
Why a refund is being offered when accepting a dispute. The payment provider accepts only these values, so a free-text reason cannot be forwarded.
AdminPaymentDisputeRefund
object
A refund offered to the cardholder when accepting a dispute.
2 properties
1 required
AdminPaymentDisputeAcceptanceRecord
object
One concession already filed on a dispute.
6 properties
AdminPaymentDisputeRefundRef
object
A refund on the payment this dispute refers to.
2 properties
1 required
AdminPaymentDispute
object
27 properties
6 required
AdminPaymentDisputeList
AdminLegitimacyFactor
object
One factor's signed contribution to the composed legitimacy score.
3 properties
2 required
AdminLegitimacyOverride
object
An admin pin of an organization's tier, in force until cleared or expired.
5 properties
4 required
AdminLegitimacyScoreEvent
object
One entry in an organization's legitimacy score history.
7 properties
7 required
AdminLegitimacyScore
object
An organization's internal sender legitimacy standing, for abuse review. The score is not visible to customers.
8 properties
7 required
AdminLegitimacyTierOverrideUpdate
object
3 properties
2 required
AdminLegitimacyOrganization
object
3 properties
3 required
AdminLegitimacyOrganizationList
object
1 property
1 required
AdminTrustProviderKind
string
The system that establishes whether a trust requirement is met.
AdminTrustGate
object
5 properties
5 required
AdminTrustGateList
object
1 property
1 required
AdminTrustGateOverrideUpdate
object
2 properties
2 required
AdminTrustVerification
object
14 properties
14 required
AdminTrustVerificationList
AdminTrustUnavailablePolicy
string
The intended handling for a requirement when its provider status can't be confirmed — hold it for review, or treat it as met. Stored on the requirement; not ye…
AdminTrustGateDefinition
object
9 properties
7 required
AdminTrustGateDefinitionList
object
1 property
1 required
AdminTrustGateDefinitionCreate
object
7 properties
6 required
AdminTrustGateDefinitionUpdate
object
6 properties
5 required
AdminTrustGateDefinitionReorder
object
The complete ordered list of gate slugs. Positions are rewritten as 1..n in one pass, so a list that omits any gate in the catalog is rejected.
1 property
1 required
AdminTrustActionPolicy
object
2 properties
2 required
AdminTrustActionPolicyList
object
1 property
1 required
AdminTrustActionPolicyCreate
object
2 properties
2 required
AdminTrustActionPolicyReorder
object
The complete ordered list of the gate slugs this action requires. Positions are rewritten as 1..n in one pass, so a list that omits any of the action's gates i…
1 property
1 required
AdminTrustAuditEvent
object
7 properties
6 required
AdminTrustAuditEventList
AdminTrustInquiryState
string
Where an inquiry stands, derived from the record rather than stored. The four values are mutually exclusive and cover every record. inflight means the person h…
AdminTrustInquiryVerdict
string
The verdict staff submitted to the verification provider. A submission, not an outcome: the provider stays the only writer of the requirement's standing, and t…
AdminTrustInquiry
object
19 properties
19 required
AdminTrustInquiryList
AdminTrustInquirySummaryStatus
string
Pending awaits generation; processing holds an active generation lease; ready has a saved summary. Failed exhausted generation retries; unavailable could not r…
AdminTrustInquirySummaryFinding
object
3 properties
3 required
AdminTrustInquirySummaryContent
object
3 properties
3 required
AdminTrustInquirySummary
object
Saved AI explanation and generation state for one captured evidence fingerprint and prompt version.
8 properties
8 required
AdminTrustInquiryDocumentRef
object
4 properties
4 required
AdminTrustInquiryDetail
object
7 properties
7 required
AdminTrustInquiryDecisionRequest
object
2 properties
1 required
AccountingBookID
string
AdminAccountingEnvironment
string
NetSuite environment used by this book; empty while not configured.
AdminAccountingBook
Book
AdminAccountingBookList
A page of accounting book records.
AdminAccountingAccountType
string
Classification of the ledger account.
AdminAccountingAccountCreate
object
A local chart account. An empty NetSuite reference allows preparation but blocks approval and export.
5 properties
5 required
AdminAccountingBookCreate
object
Creates one legal-entity and currency book. NetSuite settings may be empty while sources and local journals are prepared; complete mappings are required for ap…
9 properties
9 required
LedgerAccountID
string
AdminAccountingAccount
Account
AdminAccountingBookDetail
object
Book configuration and its bounded account mapping.
2 properties
2 required
AdminAccountingAccountBalance
object
AccountBalance
6 properties
6 required
AdminAccountingWorkbook
object
Account movements by calendar month. Prepared totals and verified NetSuite postings are separate; a missing cell has no journals.
4 properties
3 required
AccountingPeriodID
string
AdminAccountingPeriodState
string
Open permits financial work; closed preserves the reconciled snapshot.
AdminAccountingPeriod
Period
AdminAccountingPeriodList
A page of accounting period records.
AdminAccountingPeriodCreate
object
PeriodCreate
1 property
1 required
AccountingSourceID
string
AccountingEvidenceID
string
AdminAccountingSourceState
string
Unassigned has no journal; assigned has a journal; conflict records changed financial facts; nonposting records an explicit zero or void source that requires n…
AdminAccountingSourceSummary
Accounting source summary. Read the individual record for complete retained detail.
AdminAccountingSourceList
A page of accounting source records.
AdminAccountingJournalState
string
Prepared awaits independent approval; approved has been independently reviewed and follows its source owner's posting route; exported awaits a matched NetSuite…
AccountingJournalID
string
AdminAccountingJournalSummary
Accounting journal summary. Read the individual record for complete retained detail.
AdminAccountingJournalList
A page of accounting journal records.
AdminAccountingJournalLineCreate
object
JournalLineCreate
6 properties
5 required
AdminAccountingJournalCreate
object
JournalCreate
6 properties
5 required
AdminAccountingJournalLine
object
JournalLine
7 properties
6 required
AdminAccountingJournal
Journal
AccountingExportID
string
AdminAccountingExportState
string
Exported awaits destination results; posted has matched results for all claimed journals.
AdminAccountingExportSummary
Accounting export summary. Read the individual record for complete retained detail.
AdminAccountingExportList
A page of accounting export records.
AdminAccountingExportCreate
object
ExportCreate
2 properties
2 required
AdminAccountingExport
Export
AccountingExceptionID
string
AdminAccountingExceptionResolutionCreate
object
Records independent evidence that explains an observed accounting exception.
5 properties
4 required
AdminAccountingException
object
Exception
14 properties
7 required
AdminAccountingExceptionList
A page of accounting exception records.
AdminAccountingIssuerCurrencyTax
object
Invoice tax restated in the issuer's fiscal currency using the retained issue-time exchange rate.
3 properties
3 required
InvoiceID
string
AdminAccountingInvoiceApplication
object
Billing-owner evidence of a fully prepaid invoice charge. This is a balance transfer, not additional revenue or tax.
3 properties
3 required
PaymentReceiptID
string
AdminAccountingActivityFacts
object
Original references retained with a regional billing activity observation.
13 properties
5 required
AdminAccountingInvoiceObservationLine
object
Original invoice line evidence. Missing amounts and service dates remain unknown.
10 properties
1 required
AdminAccountingInvoiceObservation
object
Retained invoice document evidence. These observations require canonical billing verification before approval or export.
19 properties
18 required
AdminAccountingSourceLine
object
SourceLine
8 properties
5 required
AdminAccountingSource
Source
AdminAccountingEvidence
object
Evidence
8 properties
8 required
AdminAccountingReceipt
object
Receipt
6 properties
6 required
AdminAccountingJournalApprovalCreate
object
Approves the exact journal version shown to the reviewer.
1 property
1 required
AdminAccountingJournalReversalCreate
object
Prepares the one permanent reversal of the journal identified by the request path.
4 properties
3 required
AdminAccountingSourceImportFormat
string
Source file format. Invoice document observations support local review only. Airwallex transaction reports retain corroborating payment and settlement evidence…
AdminAccountingSourceImportCreate
object
Source evidence import.
4 properties
3 required
AdminAccountingImportResult
object
Import result. Identical observations replay; changed or duplicate financial observations remain visible as exceptions.
4 properties
4 required
AdminAccountingImportCreate
object
ImportCreate
3 properties
3 required
AdminAccountingHistory
object
Available source coverage observed in one region for an accounting book.
7 properties
7 required
AdminAccountingHistoryRunStatus
string
Lifecycle of the logical history request. Running observes months; monitoring waits for the next check. Failed retains its cursor and may be resumed only while…
AdminAccountingHistoryRunMonth
object
9 properties
9 required
AdminAccountingHistoryRun
object
14 properties
14 required
AdminAccountingSourceSyncMonthCreate
object
One bounded monthly observation of existing accounting sources.
2 properties
2 required
AdminAccountingHistoryStartAction
string
AdminAccountingHistoryStart
object
Start durable regional history synchronization. Retrying the same request identity preserves its original coverage; different coverage is rejected.
5 properties
5 required
AdminAccountingHistoryControlAction
string
Resume only a current failed request without cancellation intent. Cancel stops future source activity; an already-running month may finish before cancellation…
AdminAccountingHistoryControl
object
Control an accepted regional history request without changing its source coverage.
2 properties
2 required
AdminAccountingSourceSyncCreate
Observe one month, start durable regional history synchronization, or control an accepted history request. Source coverage is immutable after a durable start.…
AdminAccountingSourceSyncResult
object
Retained source and journal preparation results for one month and region.
15 properties
15 required
AdminAccountingInvoiceSyncCreate
object
InvoiceSyncCreate
1 property
1 required
AdminAccountingAllocationCreate
object
Exact settlement-to-bank allocation. Total allocations cannot exceed either source amount.
4 properties
4 required
AdminAccountingProcessorEvidence
object
Exact provider payment ID, currency and amount corroboration of the current source snapshot. Stages overlap; settlement is not bank payout or recognized revenu…
10 properties
10 required
AdminAccountingControlKind
string
Reconciliation control supported by immutable evidence and the current period snapshot.
AdminAccountingControl
object
Control
9 properties
9 required
AdminAccountingSourceTotal
object
Retained record inventory for one close control. NetSuite counts accepted posted journals; other controls count source records.
3 properties
3 required
AdminAccountingExceptionGroup
object
A complete period group of unresolved exceptions. Source amounts are affected evidence, not measured financial differences; groups may overlap.
5 properties
5 required
AdminAccountingCloseStatus
object
CloseStatus
19 properties
16 required
AdminAccountingControlCreate
object
ControlCreate
6 properties
6 required
AdminAccountingCloseCreate
object
CloseCreate
1 property
1 required
AdminBusinessEntityList
object
The set of Bird legal entities available to invoice organizations.
1 property
1 required
AdminEmailTemplateContentReveal
object
A template's published content for one language, revealed for staff review. Carries the rendered subject and bodies only, not the visual builder document: that…
5 properties
5 required
AdminWhatsAppStatsSeriesPeriod
object
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to. The series is bucketed by day, ho…
4 properties
3 required
AdminWhatsAppStatsTotals
object
Aggregate totals across the whole window. Each lifecycle count is the sum of per-bucket distinct counts, so a message active in two buckets contributes one to…
3 properties
3 required
AdminWhatsAppStatsResponse
object
Platform-wide WhatsApp sending, volume, and deliverability statistics over time, within a single region. series is one row per bucket in chronological order (c…
4 properties
4 required
WhatsAppStatsSortMetric
string
Metric to rank breakdown rows by, applied descending. Defaults to delivered.
WhatsAppStatsBreakdownPeriod
object
The date range the server actually computed against. Echoed back so clients can render the period without tracking it themselves and so cached responses can be…
3 properties
2 required
AdminWhatsAppTemplateCategoryStatsPoint
object
Delivery and engagement counts for a single WhatsApp template category over the requested period.
3 properties
3 required
AdminWhatsAppStatsByTemplateCategoryResponse
object
Per-template-category breakdown for one customer organization or platform-wide within a single region, ranked by the sort metric (default delivered) descending…
4 properties
4 required
AdminWhatsAppCountryStatsPoint
object
Delivery and engagement counts for a single destination country over the requested period.
3 properties
3 required
AdminWhatsAppStatsByCountryResponse
object
Per-country breakdown for one customer organization or platform-wide within a single region, ranked by the sort metric (default delivered) descending and cappe…
4 properties
4 required
AdminWhatsAppErrorCodeStatsPoint
object
Delivery and engagement counts for messages that failed with a single Bird-normalized error code over the requested period. Every row in this breakdown is a fa…
3 properties
3 required
AdminWhatsAppStatsByErrorCodeResponse
object
Per-error-code failure breakdown for one customer organization or platform-wide within a single region, ranked by the sort metric (default failed) descending a…
4 properties
4 required
AdminOrganizationEmailCompetitiveUsage
object
One organization's Competitive Insights request, error and latency figures for the range. These counts are exact. The rollup behind the region-wide totals carr…
4 properties
4 required
AdminOrganizationEmailCompetitive
object
One organization's Competitive Insights footprint in its region: the watchlists its workspaces keep, and the traffic it sent the product. Unlike the region-wid…
7 properties
7 required
AdminRealtimeUsageAppRow
AdminRealtimeUsage
object
Realtime usage for an organization over a time window, aggregated across every workspace it owns. The same shape as the workspace-scoped read, with the owning…
5 properties
4 required
AdminRealtimeApp
object
A Bird Realtime app as staff see it: the customer-facing identity plus the internal handles the platform reads deliberately withhold (the numeric app id and th…
8 properties
8 required
AdminRealtimeAppList
AdminSMSStatsSeriesPeriod
object
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to. The series is bucketed by day, ho…
4 properties
3 required
AdminSMSStatsTotals
object
Aggregate totals across the whole window. Each lifecycle count is the sum of per-bucket distinct counts, so a message active in two buckets contributes one to…
2 properties
2 required
AdminSMSStatsResponse
object
Platform-wide SMS sending, volume, and deliverability statistics over time, within a single region. series is one row per bucket in chronological order (counts…
4 properties
4 required
AdminSMSCountryStatsPoint
object
SMS lifecycle counts for a single destination country over the requested period.
2 properties
2 required
AdminSMSStatsByCountryResponse
object
Per-country SMS breakdown for one customer organization or platform-wide within a single region, ranked by the sort metric (default accepted) descending and ca…
4 properties
4 required
AdminSMSCarrierStatsPoint
object
SMS lifecycle counts for a single delivery carrier over the requested period.
2 properties
2 required
AdminSMSStatsByCarrierResponse
object
Per-carrier SMS breakdown for one customer organization or platform-wide within a single region, ranked by the sort metric (default accepted) descending and ca…
4 properties
4 required
AdminSMSErrorCodeStatsPoint
object
SMS lifecycle counts for messages that failed with a single Bird-normalized error code over the requested period. Every row in this breakdown is a failure outc…
2 properties
2 required
AdminSMSStatsByErrorCodeResponse
object
Per-error-code SMS failure breakdown for one customer organization or platform-wide within a single region, ranked by the sort metric (default failed) descendi…
4 properties
4 required
AdminApiKeyList
AdminSSOConnectionStatus
string
Lifecycle state of a connection, as staff see it. Carries one state the customer-facing vocabulary does not: a deleted connection is retained rather than remov…
AdminSSOJitMode
string
Whether a first sign-in through this connection may provision the member. - automatic: it does. Every connection is created this way, and no endpoint changes i…
AdminSSOConnectionSummary
object
One of the organization's identity-provider connections, as staff need to read it when a member cannot sign in. Carries no identity-provider secrets or certifi…
10 properties
8 required
AdminSSOVerifiedDomain
object
A domain the organization has claimed for single sign-on. Only a verified claim is exclusive: while this organization holds one, no other can verify the same d…
5 properties
4 required
AdminOrganizationSSO
object
An organization's single sign-on configuration, read for support rather than for the owner: whether sign-in through an identity provider is required, which con…
3 properties
3 required
AdminQuotaDefinition
object
Static definition of a quota — its key, display name, unit, and default value.
6 properties
6 required
AdminQuotaDefinitionList
object
1 property
1 required
QuotaOverrideView
object
The active or expired override applied to a quota. Present on admin responses only.
4 properties
3 required
AdminQuota
object
A quota as seen by an admin — default, effective limit, usage, override, and status.
14 properties
9 required
AdminQuotaList
object
1 property
1 required
QuotaOverrideUpdate
object
Sets or replaces the override for a quota.
4 properties
2 required
AdminRateLimitPolicyDefinition
object
A customer rate-limit policy available for plan and organization configuration.
7 properties
7 required
AdminRateLimitPolicyDefinitionList
object
1 property
1 required
AdminOverrideStatus
string
Whether an organization override is absent, active, or expired.
RateLimitOverrideView
object
An active or expired organization override for a rate-limit policy. Present on admin responses only.
4 properties
3 required
AdminRateLimitPolicy
object
A customer rate-limit policy resolved for an organization.
11 properties
10 required
AdminRateLimitPolicyList
object
1 property
1 required
RateLimitOverrideUpdate
object
Sets or replaces an organization's rate override for a rate-limit policy.
3 properties
2 required
AdminVerificationCustomerConfig
Admin view of a customer's verification configuration, including the workspace it belongs to.
AdminVerificationCustomerConfigList
AdminVerificationCustomerConfigCreateRequest
object
Fields for a new verification configuration created on a customer's behalf by an admin.
4 properties
2 required
AdminIPPoolList
AdminSharedIPPoolSelection
string
The shared SparkPost pool selection. - automatic: Follow the organization's sender-legitimacy tier. - birdtrusted: Force the trusted shared route. - birdstd1:…
AdminSharedIPPoolRouting
object
1 property
1 required
AdminSharedIPPoolRoutingUpdate
object
2 properties
2 required
AdminDedicatedIPList
AdminDedicatedIPCreate
object
2 properties
1 required
SupportCase
object
8 properties
5 required
SupportCaseList
object
1 property
1 required
SupportChatMetrics
object
7 properties
2 required
AdminUser
object
6 properties
5 required
AdminUserList
AdminUserCreate
object
2 properties
2 required
AdminUserUpdate
object
1 property
1 required
AdminReviewSource
string
What flagged a user for manual trust and safety review. sift: a provider decision did. admin: a staff member did. Closed rather than extensible because the set…
AdminPlatformUserOrg
object
One organization a platform user belongs to, with their role in it, for the users list.
3 properties
2 required
AdminPlatformUser
object
33 properties
9 required
AdminPlatformUserList
AdminPlatformUserMembership
object
4 properties
3 required
AdminPlatformUserMembershipList
object
1 property
1 required
AdminPlatformUserSessionList
object
1 property
1 required
AdminPlatformUserBanRequest
object
2 properties
1 required
AdminPlatformUserDeviceOTPExemptionRequest
object
1 property
1 required
AdminAuditLogFields
object
Admin-audit-only fields layered on top of the shared audit fields.
2 properties
2 required
AdminAuditLogEntry
object
A single platform (admin) audit log entry as returned in list responses (without bodies).
AdminAuditLogEntryList
AdminAuditLogEntryDetail
object
A single platform audit log entry with the captured request and response bodies.
AdminBillingAutoTopupSettings
object
The organization's stored automatic top-up configuration. Amounts use the wallet currency. Enabling the setting does not guarantee that a saved card can be cha…
5 properties
5 required
AdminBillingWallet
object
10 properties
10 required
AdminBillingWalletList
object
1 property
1 required
AdminBillingWalletUpdate
object
1 property
1 required
AdminBillingWalletTransaction
object
14 properties
6 required
AdminBillingWalletTransactionList
AdminBillingWalletAdjustment
object
3 properties
3 required
AdminBillingWalletCurrencyConversion
object
1 property
1 required
SubscriptionID
string
ChannelSlug
string
A product channel slug. Open enum: new channels may be added over time; treat any unrecognized value as a future channel rather than an error.
BillingProductSummary
object
7 properties
5 required
AdminBillingSubscription
object
18 properties
12 required
AdminBillingSubscriptionList
object
1 property
1 required
AdminBillingSubscriptionCreate
object
5 properties
2 required
AdminBillingSubscriptionUpdate
object
3 properties
AdminBillingSubscriptionCancel
object
1 property
1 required
BillingUsageDailyBucket
object
3 properties
2 required
BillingUsageProjection
object
2 properties
1 required
BillingUsageDomainBucket
object
Volume breakdown for one sending domain in the period. Spend is not included because email is a metered product with a flat included allowance rather than per-…
3 properties
3 required
BillingUsageMetered
object
7 properties
4 required
BillingUsageCountryBucket
object
3 properties
2 required
BillingUsageTransactional
object
5 properties
2 required
BillingUsageItem
object
8 properties
6 required
BillingUsageResponse
object
3 properties
3 required
BillingProductDimensions
object
Dimension field names for ratecard products.
1 property
BillingProductMatchingSpec
object
Fallback tiers for pricing a ratecard product when a request does not match on every dimension.
1 property
BillingTaxCategory
string
Tax category for VAT/sales-tax classification.
BillingProductUseIncrement
boolean
Whether this product is billed by session duration. When true, its prices use an increment (initial and continuation seconds) to determine how each session's d…
AdminBillingProduct
object
19 properties
10 required
AdminBillingProductList
BillingProductSlug
string
URL-safe identifier for a billing product. Lowercase letters and digits, separated by underscores. Must start with a letter.
AdminBillingMeterCreate
object
2 properties
2 required
AdminBillingUnitSubscriptionConfigInput
object
2 properties
AdminBillingProductCreate
object
15 properties
4 required
AdminBillingProductUpdate
object
14 properties
MeterID
string
AdminBillingMeter
object
6 properties
6 required
AdminBillingSubscriptionPage
AdminRevenueMetricKind
string
Financial measure and its attribution basis. - mrrmonthly: Current monthly-billed paid-plan MRR, excluding removed organizations. - mrrannual: Current annual-b…
AdminRevenueMetric
object
A native-currency financial measure, optionally converted to the reporting currency. An absent day indicates a current snapshot.
5 properties
3 required
AdminRevenueAccount
object
An organization on a bounded financial leaderboard, with amounts in its wallet currency. Balances are current snapshots.
5 properties
5 required
AdminRevenueCollectionKind
string
Collection policy that created the lifecycle.
AdminRevenueCollectionStatus
string
Current lifecycle state. An exhausted lifecycle has no remaining automatic retries.
AdminRevenueCollectionOutcome
object
Current outcome of collection lifecycles created on the given day. Counts are independent of currency and do not count individual retries as new lifecycles.
4 properties
4 required
AdminRevenueReport
object
Financial reporting over complete UTC days. Period flows and current snapshots remain separate; no amount certifies bank receipt or recognized revenue.
11 properties
11 required
AdminBillingMrrByCurrency
object
Monthly recurring revenue for a single currency.
4 properties
4 required
AdminBillingSubscriptionStatusCounts
object
Count of active paid subscriptions by status.
6 properties
6 required
AdminBillingPlansSummary
object
Aggregate figures for active paid plan subscriptions across all organizations, narrowed by the same filters as the plan list.
6 properties
5 required
WalletTransactionType
string
Wallet transaction type. - topup: a manual or automatic top-up credit. - charge: a usage or subscription debit. - refund: a refunded payment. It debits the wal…
AdminBillingWalletTransactionPage
AdminProviderFundingState
string
Funded identifies the first confirmed provider top-up. Not observed means this region has no qualifying posting in complete retained history. Unknown means his…
AdminProviderFunding
object
4 properties
4 required
AdminOrganizationProviderFunding
object
3 properties
3 required
AdminFirstProviderFundings
object
2 properties
2 required
AdminBillingSubscriptionStatusBreakdown
object
Count of subscriptions by status, including terminal and scheduled states.
8 properties
8 required
AdminBillingPricingModelCount
object
Number of subscriptions for a single pricing model.
2 properties
2 required
AdminBillingSubscriptionsSummary
object
Aggregate figures for subscriptions across all organizations, narrowed by the same filters as the subscription list. The free plan is excluded.
4 properties
4 required
AdminBillingMrrPoint
object
Plan MRR on a single calendar day, summed across every currency into the base currency (USD). Booking counts every recurring charge whose billing period covers…
3 properties
3 required
AdminBillingMrrTimeseries
object
Platform-wide daily plan MRR over the window, converted to a single base currency (USD) via the latest FX rates. One point per calendar day, oldest first.
1 property
1 required
AdminBillingPaygPoint
object
Pay-as-you-go revenue for the 30 days up to and including a single calendar day, summed across every currency into the base currency (USD). Counts metered usag…
2 properties
2 required
AdminBillingPaygTimeseries
object
This region's daily pay-as-you-go revenue run-rate over the window, converted to a single base currency (USD) via the latest FX rates. One point per calendar d…
1 property
1 required
BillingInvoiceStatus
string
Payment status of the invoice. - open: issued and awaiting full payment. - paid: fully settled. - partial: partially paid; a balance remains. - void: cancelled…
BillingInvoiceType
string
Accounting classification of the invoice. The debit value is a standard invoice for an amount you owe us, such as charges, monthly recurring costs, or overage.…
AdminBillingInvoice
object
An admin view of a billing invoice, includes organizationid for cross-org listing.
16 properties
13 required
AdminBillingInvoiceList
InvoiceLineItemID
string
BillingInvoiceLineItem
object
A single line on a billing invoice.
15 properties
8 required
AdminBillingInvoiceDetail
object
Admin view of an invoice with line items and amendable fields.
AdminBillingInvoiceUpdate
object
Amendable fields on an invoice.
2 properties
AdminBillingInvoicePayment
object
Request body for recording an off-platform payment on an invoice.
1 property
1 required
AdminBillingPaymentReceipt
object
An admin view of a wallet top-up payment receipt; includes organizationid for cross-org listing.
10 properties
7 required
AdminBillingPaymentReceiptList
ProformaDocumentID
string
AdminBillingProformaDocument
object
An admin view of a pro forma document; includes organizationid for cross-org listing.
6 properties
6 required
AdminBillingProformaDocumentList
AdminPaymentDisputeAccept
object
Concede a dispute, optionally with a partial refund.
1 property
AdminPaymentDisputeDocumentType
string
How an evidence bundle is categorised in the challenge submission.
AdminPaymentDisputeDocument
object
One bundle of evidence files submitted with a challenge.
3 properties
2 required
AdminPaymentDisputeChallenge
object
A challenge submission. Only disputes awaiting a response at the RFI or chargeback stage can be challenged, and at least one evidence document is required.
5 properties
2 required
AdminPaymentDisputeEvidenceFileCreate
object
An evidence file to attach to a dispute challenge.
3 properties
3 required
AdminPaymentDisputeEvidenceFile
object
A stored evidence file, referenced by identifier when challenging.
3 properties
3 required
AdminPaymentCustomerResolveRequest
object
1 property
1 required
AdminPaymentCustomerResolution
object
2 properties
2 required
AdminPaymentCustomerOrgResolution
object
1 property
1 required
PlanEntitlementID
string
AdminBillingPlanEntitlement
object
7 properties
5 required
AdminBillingPlanEntitlementList
object
1 property
1 required
AdminBillingPlanEntitlementCreate
object
3 properties
2 required
AdminBillingOrgPlanEntitlement
AdminBillingOrgPlanEntitlementList
object
1 property
1 required
AdminBillingOrgPlanEntitlementCreate
object
4 properties
3 required
PlanQuotaID
string
AdminBillingPlanQuota
object
A per-plan quota limit, effective between effectivefrom and effectiveto.
7 properties
6 required
AdminBillingPlanQuotaList
object
1 property
1 required
AdminBillingPlanQuotaCreate
object
3 properties
3 required
PlanRateLimitPolicyID
string
AdminBillingPlanRateLimitPolicy
object
A per-plan customer rate-limit policy value with an effective date range.
7 properties
6 required
AdminBillingPlanRateLimitPolicyList
object
1 property
1 required
AdminBillingPlanRateLimitPolicyCreate
object
3 properties
3 required
AdminBillingPlanEntitlementExpire
object
1 property
AdminBillingPlanQuotaExpire
object
1 property
1 required
AdminBillingPlanRateLimitExpire
object
1 property
1 required
PlanConfigID
string
AdminBillingPlanConfig
object
7 properties
7 required
AdminBillingPlanConfigUpdate
object
3 properties
UnitSubscriptionConfigID
string
AdminBillingUnitSubscriptionConfig
object
6 properties
6 required
AdminBillingRateCard
object
10 properties
6 required
AdminBillingRateCardList
object
1 property
1 required
AdminBillingRateCardCreate
object
6 properties
1 required
AdminBillingRateCardVersion
object
11 properties
6 required
AdminBillingRateCardVersionList
object
1 property
1 required
AdminBillingRateCardVersionCreate
object
1 property
PriceID
string
BillingPriceIncrement
string
Billing increment as initial/continue whole seconds, both 1–999, for example, '60/6' bills a 60-second minimum then in 6-second steps.
AdminBillingPrice
object
7 properties
6 required
AdminBillingRateCardVersionDetail
AdminBillingPriceCreate
object
4 properties
3 required
AdminBillingRateCardImportRequest
object
1 property
1 required
AdminBillingRateCardImportResult
object
3 properties
3 required
AdminBillingPriceUpdate
object
2 properties
AdminBillingCurrencyList
object
1 property
1 required
AdminBillingOrgRateCardList
object
1 property
1 required
MinimumCommitID
string
MinimumCommitPeriodType
string
Billing period of the commitment. The monthly period means the committed spend applies to each monthly billing period. We charge any shortfall at the end of ea…
AdminBillingMinimumCommit
object
10 properties
9 required
AdminBillingMinimumCommitList
object
1 property
1 required
AdminBillingMinimumCommitCreate
object
5 properties
4 required
AdminBillingPlanAssign
object
5 properties
2 required
WalletPendingOperationID
string
AdminBillingPlanAssignResult
object
4 properties
2 required
BillingPlanChangePreview
object
Quote for a plan change that shows charges and renewal details before the change is applied.
10 properties
10 required
AdminBillingOpeningInvoiceCreate
object
Request body for issuing an opening invoice against an organization's uninvoiced subscription charges.
1 property
1 required
CostBookID
string
CostBookVersionID
string
AdminCostBook
object
9 properties
6 required
AdminCostBookList
object
1 property
1 required
AdminCostBookCreate
object
3 properties
2 required
AdminCostBookVersion
object
9 properties
6 required
AdminCostBookDetail
object
2 properties
2 required
AdminCostBookImportRequest
object
2 properties
1 required
AdminCostBookImportResult
object
2 properties
2 required
CostPriceID
string
AdminCostBookPrice
object
7 properties
4 required
AdminCostBookVersionDetail
object
3 properties
2 required
MarginFloorDialID
string
AdminMarginFloorDial
object
One recorded change to a product's margin floor. Rows are appended, never edited, so the floor a past quote was judged against stays readable.
11 properties
6 required
AdminProductMarginFloor
object
One product's whole floor position: what the cost model says, what an operator dialled on top of it, which of the two is in force, and any change still waiting…
7 properties
4 required
AdminMarginFloorDialCounts
object
The pending floor-change counters for the signed-in staff member. Pending and needs-me are separate because they answer different questions: one is the queue,…
2 properties
2 required
AdminCostBookMarginFloor
object
4 properties
4 required
AdminCostBookMarginFloorUpdate
object
1 property
1 required
AdminMarginFloorDialRequest
object
Set a product's margin floor. Raising it, or restoring it to the model floor, takes effect immediately. Lowering it below the model floor is a concession: it n…
3 properties
1 required
AdminMarginFloorDialDecision
object
The second signature on a floor change that loosens the model floor.
2 properties
1 required
AdminSalesDocumentKind
string
AdminSalesDocumentState
string
draft: editable authored content. inreview: content is pinned and cannot be edited. changesrequested: returned content may be edited or resubmitted. approved:…
AdminSalesDocumentCategory
string
Sales Studio proposals, mutual action plans and outreach documents.
SalesDocumentID
string
SalesDocumentReviewID
string
ApprovalRequestID
string
AdminSalesDocumentBase
AdminSalesDocumentSummary
AdminSalesDocumentList
AdminSalesDocumentBlockKind
string
AdminSalesDocumentBlock
object
4 properties
2 required
AdminSalesDocumentContent
object
Ordered authored blocks using schema version 1. Across all blocks, the combined UTF-8 bytes of title and body must not exceed 1,000,000. This aggregate byte li…
2 properties
2 required
AdminSalesDocumentCreate
object
Create a Sales Studio draft. Deal, optional quote, and kind cannot change after creation. Any associated quote must belong to the selected deal.
5 properties
4 required
AdminSalesDocument
AdminSalesDocumentUpdate
object
3 properties
3 required
SalesDocumentRevisionID
string
AdminSalesDocumentRevision
object
7 properties
7 required
AdminSalesDocumentRevisionList
SalesDocumentCommentID
string
AdminSalesDocumentComment
object
6 properties
6 required
AdminSalesDocumentCommentList
AdminSalesDocumentCommentCreate
object
2 properties
2 required
AdminSalesDocumentAction
string
requestreview: pin current content and attached quote for review. withdraw: return an active review to draft. requestchanges: independently return reviewed con…
AdminSalesDocumentReview
object
7 properties
6 required
AdminSalesDocumentReviewList
AdminSalesDocumentReviewAction
string
approve: independently approve the active review. requestchanges: independently return the active review for editing. Both actions require expectedreviewid.
AdminSalesDocumentTransition
object
4 properties
2 required
AdminDeal
object
9 properties
7 required
AdminDealList
AdminDealCreate
object
5 properties
1 required
AdminDealMarginBand
string
Margin band of an offer against its margin floor. negative means the offer prices below cost, thin that the margin is positive but below the floor, healthy tha…
AdminCostBookMarginCheck
object
8 properties
5 required
AdminDealFamily
string
Pricing family of a quote section and its products. The family fixes how lines are quantified and billed: usage prices per message or event, session per minute…
AdminDealQuotableProductDim
object
2 properties
2 required
AdminDealQuotableProduct
object
5 properties
5 required
AdminDealQuotableProductList
object
1 property
1 required
AdminDealStaffName
object
A staff member's display identity, resolved for rendering on deal surfaces.
2 properties
2 required
AdminDealUpdate
object
4 properties
AdminDealWaPenetration
object
2 properties
1 required
AdminDealRounding
object
2 properties
2 required
AdminDealFx
object
2 properties
AdminDealAssumptions
object
5 properties
3 required
AdminDealQuoteCommitPeriodType
string
How a minimum commit settles. monthly floors each period at the greater of the commit and actual spend, so a shortfall is topped up every month; annual settles…
AdminDealQuoteCommit
object
Minimum spend the customer commits to. The only commercial term that provisions: accepting the quote compiles it into a billing minimum commit.
3 properties
3 required
AdminDealQuoteSupport
object
Support commitment, recorded and fulfilled manually. Billing carries no support product, quota or SLA construct, so the tier is the name used in the order form…
2 properties
1 required
AdminDealQuotePaymentTerms
string
How the customer settles. Recorded for the proposal pack and the close checklist; neither value changes billing behaviour, and a credit limit is set through th…
AdminDealQuoteTerms
object
Commercial terms of the quote round, alongside its prices. Every term is optional: a quote may state none. Amounts are decimal strings in the deal's own curren…
4 properties
AdminDealQuote
object
14 properties
10 required
AdminDealQuoteList
object
1 property
1 required
AdminDealQuoteCreate
object
1 property
QuoteSectionID
string
AdminDealQuoteSection
object
4 properties
4 required
DealLineID
string
DealLineGroupID
string
AdminDealDims
object
Pricing dimension values for a line, keyed by the product's pricing dimensions. A subset is accepted when the remaining dimensions follow the product's catalog…
AdminDealIncrement
object
Billing increment for a per-minute line — how call duration rounds up when billed.
2 properties
2 required
AdminDealIncludedLanding
string
How included units are honored once the deal is live. foldin lowers the contractual unit price so the inclusion is built into the billed rate; credit keeps the…
AdminDealLine
object
16 properties
6 required
AdminDealLineGroup
object
4 properties
4 required
AdminDealQuoteContent
object
3 properties
3 required
AdminDealOfferEvaluation
object
One offered price floor-checked against its own cost basis — the SMS offer against the SMS cost, the blended offer against the penetration-blended cost.
5 properties
2 required
AdminDealComputedLine
object
19 properties
4 required
AdminDealQuoteTotals
object
3 properties
1 required
AdminDealQuoteDetail
object
A quote round with its stored content plus the pricing computed on read.
AdminDealQuoteUpdate
object
3 properties
AdminDealSectionLineInput
object
11 properties
1 required
AdminDealQuoteSectionInput
object
3 properties
3 required
AdminDealSectionsReplace
object
1 property
1 required
AdminDealQuotePreviewRequest
object
2 properties
AdminDealQuotePreviewResult
object
2 properties
2 required
AdminDealQuoteImportRequest
object
3 properties
AdminDealImportColumn
object
3 properties
3 required
AdminDealImportLine
object
6 properties
2 required
AdminDealImportFieldDiff
object
3 properties
1 required
AdminDealImportLineDiff
object
3 properties
2 required
AdminDealQuoteImportResult
object
7 properties
3 required
AdminDealQuoteApprovalCreate
object
1 property
1 required
AdminApprovalRequestStatus
string
Current lifecycle state of an approval request.
AdminApprovalRequestMetadata
object
6 properties
6 required
AdminApprovalRequestSummary
AdminApprovalRequestList
AdminDealQuoteApprovalSendBackCreate
object
2 properties
2 required
AdminDealQuoteTransition
object
1 property
1 required
DealArtifactID
string
AdminDealArtifact
object
7 properties
7 required
AdminDealArtifactList
object
1 property
1 required
AdminDealArtifactCreate
object
2 properties
1 required
DealSendID
string
AdminDealSend
object
9 properties
8 required
AdminDealSendList
object
1 property
1 required
AdminDealSendCreate
object
5 properties
5 required
AdminDealSendRecipient
object
5 properties
2 required
AdminDealSendDetail
object
2 properties
2 required
ApprovalFlowID
string
AdminApprovalFlowMetadata
object
4 properties
4 required
AdminApprovalFlowSummary
AdminApprovalFlowList
AdminApprovalFlowStageFields
object
5 properties
5 required
ApprovalFlowStageID
string
AdminApprovalFlowStage
AdminApprovalFlow
AdminApprovalFlowStageInput
AdminApprovalFlowUpdate
object
2 properties
2 required
AdminApprovalPendingFor
string
Staff member whose actionable approval queue to return.
ApprovalRequestStageID
string
AdminApprovalRequestStage
object
5 properties
5 required
ApprovalDecisionID
string
AdminApprovalDecisionOutcome
string
Decision taken on an approval stage.
AdminApprovalDecision
object
6 properties
6 required
AdminApprovalRequest
AdminApprovalDecisionCreate
object
3 properties
2 required
AdminTemporalOpenCounts
object
1 property
1 required
AdminTemporalFailuresByStatus
object
3 properties
3 required
AdminTemporalTypeFailure
object
4 properties
4 required
AdminTemporalSummaryFailures
object
3 properties
3 required
AdminTemporalRegionFailures
object
1 property
1 required
AdminTemporalSummaryRegion
object
5 properties
5 required
AdminTemporalSummary
object
6 properties
6 required
AdminTemporalSearchAttributes
object
3 properties
3 required
AdminTemporalWorkflowExecution
object
11 properties
11 required
AdminTemporalWorkflowList
object
3 properties
3 required
AdminTemporalPendingActivity
object
7 properties
7 required
AdminTemporalPendingChild
object
3 properties
3 required
AdminTemporalFailure
object
3 properties
3 required
AdminTemporalWorkflowDetail
object
16 properties
16 required
AdminTemporalSchedule
object
8 properties
8 required
AdminTemporalScheduleList
object
3 properties
3 required
AdminLitequeueTube
object
One litequeue tube's job counts in a single region, summed across that region's nodes.
7 properties
7 required
AdminLitequeueTubeList
object
Every tube in one region that currently holds a job. A tube holding nothing is absent rather than zero, because the nodes only report tubes they still hold. No…
2 properties
2 required
AdminLitequeueBuriedJob
object
One buried job's metadata, without its payload.
8 properties
8 required
AdminLitequeueBuriedJobList
AdminLitequeueBuriedHistoryPoint
object
One sample of a buried-job series.
2 properties
2 required
AdminLitequeueBuriedHistorySeries
object
One labelled buried-job series.
2 properties
2 required
AdminLitequeueBuriedHistory
object
Buried-job counts over time for one region, read from that region's metrics backend. This is history, not current state. The metric keeps reporting a stale val…
3 properties
3 required
AdminLitequeueJobBody
object
A buried job's decoded payload, returned to staff authorized for that channel's content. The tube family decides which scope authorizes the read, and a family…
4 properties
4 required
AdminLitequeueRestoreRequest
object
The tube or family to restore. There is no job-id form: the queue exposes un-burying only per tube, so a restore always covers every buried job the pattern mat…
1 property
1 required
AdminLitequeueActionResult
object
What the action actually did. A non-empty failednodes alongside a non-zero affected is a real outcome rather than a contradiction, because each node holds its…
2 properties
2 required
AdminLitequeuePurgeTube
object
Purge every buried job in a tube or family.
1 property
1 required
AdminLitequeuePurgeJobs
object
Purge named jobs on one node. Use this to dispose of a single job as a canary before acting on its whole tube. An id that is not buried on that node is refused…
2 properties
2 required
AdminLitequeuePurgeRequest
What to purge, in exactly one of two forms: a tube pattern, or named jobs on one node. The two take different paths, so a request carrying both could not repor…
AdminLqschedJobStatus
string
Scheduled-job lifecycle status. pending is waiting for its producer to finish preparation, scheduled is waiting for its due time, dispatching is mid-handoff, d…
LiteQueueScheduledJobID
string
AdminLqschedJob
AdminLqschedJobsStatusCounts
object
Number of jobs in each status. Empty statuses have a count of zero.
6 properties
6 required
AdminLqschedJobList
NumberType
string
Physical type of a phone number. New number types may be added over time, so treat unrecognized values as supported types rather than errors.
NumberCapability
string
A capability supported by a phone number. New capabilities may be added over time, so treat unrecognized values as supported capabilities rather than errors.
NumberOwnership
object
Where this number stands with the ownership paperwork its country requires before it may carry traffic. Present only for a number whose country requires any, s…
3 properties
2 required
Number
object
10 properties
8 required
NumberList
AvailableNumber
object
5 properties
5 required
AvailableNumberList
NumbersOrderStatus
string
Lifecycle state of a number purchase order: - charging: Securing funds. - ordering: Placing the order with the carrier. - pending: The carrier accepted the ord…
NumbersOrderID
string
NumbersOrder
object
10 properties
7 required
NumbersOrderList
NumbersOrderCompliance
object
Ownership paperwork for a number being ordered, where its country requires any. Optional always: the order completes and the number is yours either way, and su…
2 properties
1 required
NumbersOrderCreate
object
1 property
1 required
NumbersSupplierID
string
AdminNumbersSupplierSlug
string
Stable identifier a voice routing rule names this supplier by: lowercase words joined by single underscores. It names the supplier ROW, not the vendor, so a ve…
AdminNumbersSupplier
object
11 properties
4 required
AdminNumbersSupplierList
AdminNumbersSupplierCreate
object
7 properties
2 required
AdminNumbersSupplierUpdate
object
7 properties
AdminNumberPrefix
string
Digits right after the country dial code, with no country dial code and no national dialing prefix such as a leading 0.
AdminNumbersSupplierAvailableList
object
1 property
1 required
AdminNumberScope
string
Controls how this number is made available. public numbers can be purchased by customers; internal numbers are reserved for manual admin assignment; shared num…
NumbersInventoryID
string
AdminNumberOutboundRouting
string
Where a call presenting this number must leave by. default means the supplier was asked and imposes no constraint, so any carrier the dial plan picks may carry…
AdminVoiceCapabilityMetadata
object
1 property
1 required
AdminNumberCapabilityMetadata
object
Facts a supplier reports about individual capabilities of a number, keyed by capability. A capability is a bare string in capabilities, so there is nowhere on…
1 property
AdminNumbersInventoryItem
object
17 properties
12 required
AdminNumbersInventoryList
AdminNumbersInventoryCreate
object
10 properties
6 required
NumbersStockThresholdID
string
AdminNumbersStockThreshold
AdminNumbersInventoryStockRow
object
Stock held for one country, number type, and capability set, optionally per scope. Released and surrendered numbers are not stock and are never counted. Capabi…
10 properties
6 required
AdminNumbersInventoryStockSummary
object
Stock counts for every stocked country, number type, and capability set. The list is complete rather than paginated: its size is bounded by the number of disti…
1 property
1 required
AdminNumbersInventoryCountryList
object
Every country Bird holds inventory in, sorted by code. The list is complete rather than paginated: its size is bounded by the number of countries Bird has ever…
1 property
1 required
AdminNumbersInventoryBatchCreate
object
9 properties
6 required
AdminNumbersInventoryBatchResult
object
3 properties
3 required
AdminNumbersInventoryUpdate
object
7 properties
NumbersSharedAllocationID
string
AdminNumbersAllocation
object
6 properties
6 required
AdminNumbersAllocationList
AdminNumbersAllocationCreate
object
2 properties
2 required
AdminNumbersStockThresholdList
AdminNumbersStockThresholdCreate
object
Creates an operator minimum for one stock line. Omit numbertype or capabilities to cover every line in the country with that shape.
5 properties
2 required
AdminNumbersStockThresholdUpdate
object
Updates the minimum and note of an existing rule. The key (countrycode, numbertype, capabilities) is immutable; delete and create a new rule to change it. At l…
2 properties
AdminNumbersProcurementStatus
string
Lifecycle state. pending covers everything before the carrier order is placed and while it is in flight; completed means the number has been written into inven…
NumbersProcurementOrderID
string
AdminNumbersProcurement
AdminNumbersProcurementList
AdminNumbersProcurementCreate
object
6 properties
3 required
AdminNumbersProcurementBatch
object
1 property
1 required
AdminNumberRevokedReason
string
Why a dedicated number was taken back. Additional reasons may appear over time. - abuse means staff reclaimed the number for abuse. - nonpayment means staff re…
AdminNumberOwnershipState
string
Where a dedicated number stands with the ownership paperwork its country requires, derived from what is recorded against the number itself. - notrequired means…
AdminNumberOwnership
object
Where this number stands with the ownership paperwork its country requires, from what is recorded against the number itself. It carries no submission: the answ…
3 properties
1 required
AdminNumberAllocation
object
15 properties
13 required
AdminNumberAllocationList
AdminNumberAllocationCreate
object
6 properties
2 required
AdminNumberAllocationBatchCreate
object
5 properties
3 required
AdminNumberAllocationBatchFailure
object
2 properties
2 required
AdminNumberAllocationBatchResult
object
2 properties
2 required
AdminNumberRevokedReasonInput
string
Why staff are taking a dedicated number back. - abuse means staff reclaimed the number for abuse. - nonpayment means staff reclaimed the number for non-payment…
AdminNumberHolderScope
string
Whether the number was held under a dedicated allocation, which has exactly one holder at a time, or a shared allocation, which several organizations can hold…
AdminNumberIdentityAddress
object
The holder's registered address, from whichever source resolved the identity. A part the source did not state is omitted, not an empty value.
4 properties
AdminNumberIdentitySource
string
Which store the resolved identity's values came from: the number's own approved ownership submission, or the holding organization's business profile when polic…
AdminNumberIdentityGapKind
string
Why the holder's identity could not be stated, whether or not the business-profile fallback was tried too: - nevercollected: no ownership submission existed fo…
AdminNumberIdentityGap
object
Present only when the holder's identity could not be resolved from any source policy allowed.
1 property
1 required
AdminNumberIdentity
object
The holder's identity for this relation, resolved from the number's own compliance ownership submission first, and from the holding organization's business pro…
5 properties
AdminNumberHolderOfRecord
object
11 properties
11 required
AdminNumberHolderOfRecordList
object
1 property
1 required
ReportingEntityID
string
AdminReportingEntityUniverseKind
string
Whose numbers a reporting entity files for: own is Bird's own holdings in the jurisdiction, org is a named organization's. universeorganizationid is required w…
AdminReportingEntityDestination
string
The regulator destination configured for this entity.
AdminReportingEntity
AdminReportingEntityList
AdminReportingEntityCreate
object
7 properties
5 required
AdminReportingEntityUpdate
object
Fields to change on a reporting entity. Omit a field to leave it as it is. A certificate upload and a metadata change may ride in the same request; send at lea…
7 properties
AdminReportingEntityFilingState
string
This filing's lifecycle stage. - generated: built and ready to deliver, not held back by any guard. - held: generated but not sent, for the reason heldreason n…
AdminReportingEntityFilingKind
string
Whether this filing answers a schedule's period or an ad hoc disclosure request. perioddate is set for scheduled, requestref for disclosure, and never both.
AdminReportingEntityFilingHeldReason
string
Why a generated filing was held rather than delivered. - firstfiling: no previously accepted filing exists yet to compare against, so there is no baseline to j…
ReportingEntityFilingID
string
AdminReportingEntityFilingCounts
object
How this filing's universe resolved, by relation fate.
6 properties
6 required
AdminReportingEntityFilingAttempt
object
One delivery of this filing to the regulator: which rendering was sent, and what came back. A re-fire replaces the filing's current content and verdict; the at…
9 properties
9 required
AdminReportingEntityFilingRelationOutcome
string
One relation's fate on the generated document. - stated: included, with every field carried as resolved. - truncated: included, with one or more fields shorten…
AdminReportingEntityFilingRelationProvenance
object
Where a relation's resolved identity came from. Present whenever an identity resolved for the relation, including one later dropped by the format layer for a b…
3 properties
1 required
AdminReportingEntityFilingRelationGapKind
string
Why a relation was dropped from the document. - nevercollected, awaitingreview, approvalexpired, regionunreachable, profilechangedsince, compliancechangedsince…
AdminReportingEntityFilingRelationGap
object
Present only when outcome is dropped.
3 properties
3 required
AdminReportingEntityFilingRelation
object
One relation this filing's universe considered, kept whichever of stated, truncated or dropped it ended up as: the row a disclosure's provenance answers "why i…
7 properties
4 required
AdminReportingEntityFiling
object
One generated regulatory document: a reporting entity's schedule-period or ad hoc disclosure snapshot, and its own delivery lifecycle.
25 properties
23 required
AdminReportingEntityFilingList
AdminReportingEntityFilingGenerate
object
Generates the reporting entity's scheduled filing for period. Re-fires the same filing in place when one already exists for it: the row keeps its id and its co…
1 property
1 required
AdminReportingEntityFilingDeliver
object
Releases the filing for regulator delivery.
1 property
1 required
AdminReportingFormatField
object
One row of a regulatory format's transform table: the XSD element it fills, the operation applied, and whether that element's compliance source is bound by a l…
6 properties
6 required
AdminReportingFormat
object
One registered regulatory format: its identity, plus (when fetched by id) its full transform table with today's compliance coverage.
6 properties
4 required
AdminReportingFormatList
object
1 property
1 required
SMSAlphaSenderID
string
AdminSMSAlphaSender
object
6 properties
6 required
AdminSMSAlphaSenderList
AdminSMSAlphaSenderCreate
object
3 properties
3 required
AdminSMSSender
object
12 properties
10 required
AdminSMSSenderList
AdminSMSCountryRegistrationCreate
object
4 properties
2 required
AdminSMSCountryRegistration
object
16 properties
7 required
AdminSMSCountryRegistrationList
AdminSMSRegistrationRejectRequest
object
1 property
1 required
AdminTFNVerification
The admin view of a toll-free verification — the full dossier plus the owning organization and the carrier's verbatim status.
AdminTFNVerificationList
ComplianceFieldClass
string
How a catalogue field's answer can be adjudicated. - entity means the value can be checked against a company register, and only as a set: a registration number…
AdminComplianceField
object
9 properties
9 required
AdminComplianceFieldList
object
1 property
1 required
AdminComplianceFieldCreate
object
8 properties
4 required
AdminComplianceFieldUpdate
object
7 properties
AdminComplianceSection
object
2 properties
2 required
AdminComplianceSectionList
object
1 property
1 required
AdminComplianceSectionCreate
object
2 properties
2 required
AdminComplianceSectionUpdate
object
1 property
AdminComplianceDefinitionStatus
string
Where a definition version stands at its coordinate. - draft means it has never been published, and is the only state in which it can still be edited. - live m…
ComplianceDefinitionID
string
AdminComplianceBinding
object
8 properties
3 required
AdminComplianceDefinition
object
14 properties
14 required
AdminComplianceDefinitionList
AdminComplianceDefinitionCreate
object
7 properties
5 required
AdminComplianceDefinitionUpdate
object
4 properties
AdminComplianceReorder
object
The complete ordered list of this definition's field keys. Sort values are rewritten as 1..n in one transaction, so a partial list is rejected.
1 property
1 required
ComplianceRegisterPromptID
string
AdminComplianceRegisterPrompt
object
7 properties
3 required
AdminComplianceRegisterPromptUpdate
object
2 properties
2 required
AdminComplianceAIDecisionFilter
string
Filter by the effective assessment decision, or none for submissions without a current assessment.
ComplianceObligationID
string
ComplianceGrantID
string
AdminComplianceObligation
AdminComplianceSubmissionItem
object
12 properties
12 required
AdminComplianceSubjectRef
object
The sender, number, or business party a registration is about, resolved for display. Read on the single submission only.
2 properties
2 required
AdminComplianceKYBVerdict
string
What the provider's transaction decided, reduced to the two values Bird acts on. Two values, not a grade. notstrict covers every outcome short of an approval,…
AdminComplianceKYBCheckStatus
string
What the provider reported for one named check. notapplicable covers both a check its template disabled and one it could not attempt for want of data. It is de…
AdminComplianceKYBCheckOutcome
object
One named check as the provider returned it, whatever its status and whether or not Bird's decision rests on it. The verdict distils these away, so a reviewer…
2 properties
2 required
AdminComplianceKYBCheck
object
One provider check made against this submission, and the evidence for the verdict it produced. A submission can be checked more than once: an expired registrat…
7 properties
7 required
ComplianceAIAssessmentID
string
AdminComplianceAIAssessmentStatus
string
The processing state of a compliance assessment: - pending: Queued or waiting for required verification evidence; wait for processing. - running: Gathering evi…
AdminComplianceAIDecision
string
A compliance assessment outcome.
AdminComplianceAIRiskBand
string
AdminComplianceAIFindingSeverity
string
AdminComplianceAIFinding
object
5 properties
5 required
AdminComplianceAIResult
object
6 properties
6 required
AdminComplianceAIReviewDisposition
string
The staff disposition that confirms or replaces the automated assessment outcome.
AdminComplianceAIHumanDecision
object
4 properties
4 required
AdminComplianceAIAssessment
object
18 properties
16 required
AdminComplianceDecisionState
string
The verdict. Only these three can be set by an operator.
AdminComplianceReviewDraft
object
One staged verdict, visible only to reviewers. Nothing here reaches the customer until the review is published.
4 properties
4 required
AdminComplianceSubmission
AdminComplianceSubmissionList
AdminComplianceDecision
object
A verdict on one item. Rejecting requires a reason, and the reason reaches the customer.
2 properties
1 required
AdminComplianceAIReviewDecision
object
3 properties
3 required
AdminComplianceReviewPublish
object
1 property
AdminComplianceVerdictEntry
object
One verdict in a batch. The verdict half mirrors the single decide body; the field key names the answer, since a batch entry has no path segment to name it.
3 properties
2 required
AdminComplianceVerdictsCreate
object
A batch of verdicts to stage at once, at most one per field. The batch validates as a whole and is refused whole: one failing entry refuses every entry, and no…
1 property
1 required
AdminTCRVettingClass
string
Which TCR external vetting product an attempt ordered or imported. authplus is required for publicprofit brands to create any campaign; standard, enhanced, and…
AdminTCRVettingStatus
string
Lifecycle state of one external vetting attempt.
AdminTCRBrandVetting
AdminTCRBrandVettingList
object
1 property
1 required
AdminTCRBrandVettingPage
AdminTCRCampaignNumberLink
AdminTCRCampaignNumberLinkPage
AdminTCRCampaignNumberLinkAssignResult
object
1 property
1 required
AdminTCRCampaignSubmission
AdminTCRCampaignSubmissionList
TCRSubmissionResolve
object
Records the terminal outcome of a 10DLC brand or campaign submission attempt.
3 properties
1 required
AdminTCRBrandSubmission
AdminTCRBrandSubmissionList
AdminSMSTopOrganization
object
One organization in the top-senders ranking, with its SMS volume and delivery rate over the requested window.
5 properties
4 required
AdminSMSTopOrganizationList
object
The organizations sending the most SMS in a single region over the requested window, ranked by volume. Combine the regions to see a global ranking.
3 properties
3 required
AdminSMSMessage
object
Non-PII summary of a single SMS message, for admin triage. Carries only sender and structural metadata; the recipient number and the message body are deliberat…
18 properties
9 required
AdminSMSMessageList
AdminSMSContentEnvelope
object
Identifying details of the SMS message whose content was returned.
4 properties
4 required
AdminSMSContentReveal
object
The recipient and body of an SMS message, returned to authorized staff for review.
3 properties
3 required
AdminSMSSuppression
object
One suppression period for a subscriber and one sender: when it started, what started it, and what ended it. A subscriber who opts out, opts back in, and opts…
19 properties
13 required
AdminSMSSuppressionList
AdminWhatsAppGroup
AdminWhatsAppGroupList
AdminWhatsAppSuppression
object
One period during which a WhatsApp address is suppressed: when it started, what started it, and what ended it. An address suppressed, ended and suppressed agai…
17 properties
11 required
AdminWhatsAppSuppressionList
AdminWhatsAppKeywordOperation
string
What Bird does when an inbound message matches this row.
AdminWhatsAppKeywordRule
object
7 properties
5 required
AdminWhatsAppKeywordRuleList
object
2 properties
2 required
AdminWhatsAppKeywordRuleUpsert
object
4 properties
2 required
AdminWhatsAppTopOrganizationList
object
The organizations sending the most WhatsApp in a single region over the requested window, ranked by volume. Combine the regions to see a global ranking.
3 properties
3 required
AdminWhatsAppMessageBusiness
object
The business identity that sent the message. phonenumber is always present; phonenumberid is included only for account-owned numbers.
2 properties
AdminWhatsAppMessageTemplate
object
The template a message was sent from — its slug, language, and category. The filled-in placeholder values are not part of the log row; they are returned separa…
3 properties
3 required
AdminWhatsAppMessage
object
Non-PII summary of a single WhatsApp message, for admin triage. Carries only sender and structural metadata; the recipient and the template's filled-in values…
14 properties
8 required
AdminWhatsAppMessageList
AdminWhatsAppMessageContact
object
Contact on the other end of the message. Fields are omitted when not available; at least one is always present.
2 properties
AdminWhatsAppRevealedText
object
The text of a free-form WhatsApp message, returned by the content-reveal endpoint for staff review.
1 property
1 required
AdminWhatsAppRevealedTemplate
object
The template a message was sent from together with the filled-in placeholder values, returned by the content-reveal endpoint. Components are empty for an authe…
4 properties
4 required
AdminWhatsAppContentReveal
object
The recipient and content of a WhatsApp message, returned to authorized staff for review: the filled-in template for a template send, the message text for a fr…
3 properties
1 required
AdminWhatsAppNumberSetupStatus
string
Bird's own setup lifecycle for a WhatsApp number, distinct from Meta's operational state. - preparing: Bird is verifying a number it pre-verifies on the custom…
AdminWhatsAppNumber
object
10 properties
8 required
AdminWhatsAppNumberList
AdminWhatsAppNumberMetaError
object
The last error recorded for a number's connection failure.
2 properties
1 required
AdminWhatsAppPreVerificationAttempt
object
One attempt to pre-verify a number with Meta, with whatever Meta answered.
5 properties
2 required
AdminWhatsAppNumberDetail
AdminWhatsAppBusinessAccount
object
9 properties
6 required
AdminWhatsAppBusinessAccountList
AdminWhatsAppBusinessAccountDetail
AdminWhatsAppTemplate
object
12 properties
10 required
AdminWhatsAppTemplateList
AdminWhatsAppTemplateParameterFormat
string
Whether a template's variables are addressed by name or by position. Fixed at creation. Open: the vocabulary is Meta's, so a value Bird has not seen is a new M…
AdminWhatsAppTemplateDetail
AdminWhatsAppTemplateVersionState
string
A version's role for its template right now, derived from the template's draftversionid and liveversionid: there is no state column, and a reader who looks for…
AdminWhatsAppTemplateVersionSummary
object
One version of a template as a row in the admin versions table.
10 properties
8 required
AdminWhatsAppTemplateVersionList
AdminWhatsAppTemplateContentOrigin
string
Whether a language's content was authored in the workspace or came in from Bird's managed catalogue. Closed: this is Bird's own record of provenance, not a val…
AdminWhatsAppTemplateLanguageOperation
string
The kind of change a submission makes to a language. Closed: this is Bird's own classification of the request it sent, not a value Meta reports.
AdminWhatsAppTemplateMetaLock
object
Meta's hold on one template language, which blocks further edits to it.
3 properties
1 required
AdminWhatsAppTemplateLanguage
AdminWhatsAppTemplateVersionDetail
AdminAMBBusiness
object
An Apple Messages for Business brand record, with the tenant it belongs to and the fields customer-facing reads keep hidden. Superset of what the owning worksp…
13 properties
12 required
AdminAMBBusinessList
AdminAMBInvitationAccessUpdate
object
Staff record of Apple's invitation approval for a business.
1 property
1 required
AdminAMBBusinessTransitionTarget
string
The status to move a business record to. Staff record Apple's own review outcome; the legal moves are: - inreview: Apple has picked up the submission. Reachabl…
AdminAMBBusinessTransition
object
Move a business record to a new status in its Apple review lifecycle.
2 properties
1 required
AdminAMBErrorCodeCount
object
Count of one failure reason for one business over the requested window.
3 properties
3 required
AdminAMBBusinessErrorCodesResponse
object
Failure-reason counts for one business over the requested window, the drill-down behind the platform-wide error-code breakdown. This reads the underlying event…
5 properties
5 required
AdminAMBConversation
object
A conversation between a business and one customer on Apple Messages for Business, with the tenant it belongs to. Superset of what the owning workspace sees on…
25 properties
25 required
AdminAMBConversationList
AdminAMBMessage
object
One Apple Messages for Business message in the cross-tenant staff view. This is a mirror kept for paging across every workspace at once; it does not carry conv…
9 properties
9 required
AdminAMBMessageList
AdminAMBMessageDetail
object
Full Apple Messages for Business message record, with the tenant it belongs to and the fields the list view omits. Carries no message content: that is behind t…
27 properties
12 required
AdminAMBContentReveal
object
The content of an Apple Messages for Business message, returned to authorized staff for review. Carries direction and contentkind because content is a union th…
3 properties
3 required
AdminAMBStatsSeriesPeriod
object
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to. The series is bucketed by day, ho…
4 properties
3 required
AdminAMBStatsTotals
object
Aggregate outbound counts and latency percentiles across the whole window. Each count is the number of distinct messages in that state over the whole window, m…
3 properties
2 required
AdminAMBStatsResponse
object
Platform-wide Apple Messages for Business outbound sending and processing-latency statistics over time, within a single region. series is one row per bucket in…
5 properties
5 required
AdminAMBStatsSortMetric
string
Metric to rank breakdown rows by, applied descending. Shared by the volume breakdowns whose rows carry the outbound states and the send-failure rate. sendfailu…
AdminAMBStatsByBusinessResponse
object
Per-business Apple Messages for Business breakdown for one customer organization or platform-wide within a single region, ranked by the sort metric (default ac…
5 properties
5 required
AdminAMBStatsByMessageKindResponse
object
Per-message-kind Apple Messages for Business breakdown for one customer organization or platform-wide within a single region, ranked by the sort metric (defaul…
5 properties
5 required
AdminAMBStatsByCategoryResponse
object
Per-category Apple Messages for Business breakdown for one customer organization or platform-wide within a single region, ranked by the sort metric (default ac…
5 properties
5 required
AdminAMBStatsLifecycleSortMetric
string
Metric to rank breakdown rows by, applied descending. Shared by the breakdowns whose rows carry outbound state counts only, with no derived rates to sort on. f…
AdminAMBStatsByErrorCodeResponse
object
Per-error-code Apple Messages for Business breakdown for one customer organization or platform-wide within a single region, ranked by the sort metric (default…
5 properties
5 required
AdminAMBTopOrganization
object
One organization in the top-senders ranking, with its outbound volume and send-failure rate over the requested window. Apple Messages for Business has no deliv…
5 properties
4 required
AdminAMBTopOrganizationList
object
The organizations sending the most Apple Messages for Business in a single region over the requested window, ranked by accepted volume. This list is already ca…
3 properties
3 required
AdminCreateDomainBanPlan
object
3 properties
3 required
DomainBanPlanID
string
AdminDomainBanOwner
object
2 properties
2 required
AdminDomainBanOrganization
object
7 properties
7 required
AdminDomainBanSummary
object
9 properties
9 required
AdminDomainBanPlan
object
9 properties
9 required
AdminDomainBanExecutionStatus
string
Current regional enforcement status. - notstarted means no retained execution exists for this plan in this region. - running means regional bans and deletion s…
AdminDomainBanExecution
object
13 properties
13 required
AdminExecuteDomainBanPlan
object
2 properties
2 required
EmailDomainBlocklistEntryID
string
AdminEmailDomainBlocklistEntry
object
5 properties
4 required
AdminEmailDomainBlocklistEntryList
object
2 properties
2 required
AdminCreateEmailDomainBlocklistEntry
object
2 properties
1 required
IPBlockID
string
AdminIPBlock
object
6 properties
6 required
AdminIPBlockList
object
2 properties
2 required
AdminIPBlockCreate
object
3 properties
2 required
AdminMarketingSocialPlatform
string
A social media platform Bird publishes on. Closed: a write is checked against this set, and the admin app ships with the backend, so a new network reaches both…
MarketingSkillID
string
AdminMarketingSkill
object
7 properties
6 required
AdminMarketingSkillList
AdminMarketingSkillCreate
object
4 properties
3 required
AdminMarketingSkillUpdate
object
Only the fields present are changed.
4 properties
AdminMarketingChannelPlatform
string
A destination a campaign can hold a channel for: one of the social networks Bird publishes on, or bird for a marketing email sent as a broadcast from a connect…
AdminMarketingAssetKind
string
What kind of file an asset holds, derived from its stored content type rather than from anything the upload declared. image is re-encoded on the way in; video…
AdminMarketingCampaignAssetRecommendation
object
4 properties
4 required
AdminMarketingCampaignAssetSpec
object
2 properties
2 required
AdminMarketingCampaignAssetSpecList
object
1 property
1 required
AdminMarketingCampaignTag
string
One label staff group campaigns by. Lowercase letters, digits, underscore, and hyphen only, at most 32 characters. Whitespace is not accepted.
AdminMarketingCampaignTagUsage
object
2 properties
2 required
AdminMarketingCampaignTagList
object
1 property
1 required
MarketingConnectionID
string
AdminMarketingEngagementMetricKey
string
Which engagement a value counts. Each platform reports only the few most relevant to it: - views: A play or view, on Instagram, Threads, TikTok and YouTube. -…
AdminMarketingCampaignEngagementPoint
object
2 properties
2 required
AdminMarketingCampaignEngagementMetric
object
2 properties
2 required
AdminMarketingCampaignEngagementSeries
object
2 properties
2 required
AdminMarketingCampaignEngagementList
object
1 property
1 required
MarketingCampaignPublicationID
string
MarketingCampaignID
string
AdminMarketingCalendarEntry
object
5 properties
5 required
AdminMarketingCalendarList
AdminMarketingCampaignUTMMode
string
How campaign links receive UTM tags.
AdminMarketingCampaignUTM
object
Tracking applied to HTTP(S) links in the destination, body, and call to action when publishing or scheduling. Authored links are unchanged. Nonblank values rep…
6 properties
1 required
AdminMarketingCampaignPlatforms
array
The platforms this campaign should be published on. An empty set means it is not scheduled anywhere yet. Returned in the platform vocabulary's own order, not t…
AdminMarketingCampaignTags
array
Free-form labels staff group campaigns by, such as the push a campaign belongs to. Returned in alphabetical order, not the order it was sent in.
MarketingCampaignAssetID
string
AdminMarketingCampaignPublishingTarget
object
1 property
1 required
AdminMarketingCampaignYouTube
object
3 properties
3 required
AdminMarketingCampaignPublicationStatus
string
scheduled waits for its publication time and freezes the channel until then. publishing is the initial status of an immediate publication and awaits a confirme…
AdminMarketingFacebookPostFormat
string
A native Facebook link post. Absent on legacy text and photo publications.
AdminMarketingRedditSubredditDestinationKind
string
AdminMarketingRedditSubredditDestination
object
2 properties
1 required
AdminMarketingRedditProfileDestinationKind
string
AdminMarketingRedditProfileDestination
object
1 property
1 required
AdminMarketingRedditDestination
A subreddit draft or the connected account's own profile. Profile posts do not accept a subreddit name.
AdminMarketingRedditFormat
string
AdminMarketingCampaignReddit
object
Reddit post settings. Drafts may omit the title, destination, or format; publishing requires all three.
6 properties
AdminMarketingCampaignEmailSubject
string
The subject line of a Bird email channel's broadcast.
AdminMarketingCampaignEmailHeading
string
The headline rendered at the top of a Bird email channel's broadcast.
AdminMarketingCampaignEmailPreheader
string
The preview text a mail client shows beside a Bird email channel's subject.
AdminMarketingCampaignEmail
object
Bird email settings: the envelope the broadcast carries and the audience in the connected workspace it goes to. Drafts may omit any of them; publishing require…
7 properties
AdminMarketingCampaignPublicationSnapshot
object
8 properties
1 required
AdminMarketingFacebookLinkPreview
string
Whether Facebook receives the campaign image or uses the destination page preview.
AdminMarketingCampaignPublication
The latest attempt to publish this channel and the content approved for it.
AdminMarketingCampaignChannel
object
One platform's own post: the finished files it publishes, and the text and call to action that go out beside them. Publishing combines its saved copy with the…
9 properties
2 required
AdminMarketingCampaignChannels
array
The per-platform posts of this campaign. A request containing more than one entry for the same platform is rejected. A platform in platforms with no entry here…
AdminMarketingCampaignStatus
string
Where the campaign stands, rolled up from the latest publication of every platform in platforms. A platform with no channel yet, no publication yet, or a withd…
AdminMarketingCampaign
AdminMarketingCampaignList
AdminMarketingCampaignCreate
object
6 properties
2 required
AdminMarketingCampaignAnalyticsStatus
string
Collection status for a published post: pending waits for its first collection; ready has collected metrics; partial has usable metrics but some values or hist…
AdminMarketingCampaignAnalyticsPoint
object
3 properties
3 required
AdminMarketingCampaignAnalyticsSeries
object
8 properties
5 required
AdminMarketingCampaignAttributionStatus
string
Attribution availability for a campaign: off means no published post carries a utmcampaign tag, so nothing can be attributed and turning on UTM tags only affec…
AdminMarketingCampaignAttributionModel
string
Which visit a signup or inquiry is credited to. first credits the visit that first brought the person to Bird. last credits the visit saved as their most recen…
AdminMarketingCampaignAttributionCounts
object
4 properties
4 required
AdminMarketingCampaignAttributionPoint
object
2 properties
2 required
AdminMarketingCampaignAttributionPlatform
object
5 properties
5 required
AdminMarketingCampaignAttribution
object
5 properties
5 required
AdminMarketingCampaignAnalytics
object
2 properties
2 required
AdminMarketingCampaignChannelWrite
object
One platform's own post as a write states it. Separate from the read schema because assetids is optional here and guaranteed there: only the caller that owns t…
8 properties
1 required
AdminMarketingCampaignChannelWrites
array
The per-platform posts a write states. A request containing more than one entry for the same platform is rejected. A platform in platforms with no entry here h…
AdminMarketingCampaignUpdate
object
Only the fields present are changed.
7 properties
AdminMarketingCampaignChannelPublish
object
2 properties
1 required
AdminMarketingCampaignChannelPublicationCheck
object
1 property
AdminMarketingCampaignEmailPreviewRequest
object
The email content to render. It is the editor's own state rather than the saved channel, so an unsaved edit previews; apply UTM tags before sending, the same w…
7 properties
AdminMarketingCampaignEmailPreview
object
The Bird email channel as it would send.
4 properties
3 required
AdminMarketingCampaignEmailTestRequest
object
The email content to send as a test, and the connected Bird workspace to send it from. The content is the editor's own state rather than the saved channel, so…
11 properties
3 required
AdminMarketingCampaignEmailTest
object
The accepted test message.
2 properties
2 required
AdminMarketingCampaignAsset
One finished creative on a marketing campaign's platform.
AdminMarketingCampaignAssetList
object
1 property
1 required
AdminMarketingCampaignAssetUpload
object
The file to upload, sent as a multipart/form-data body.
1 property
1 required
CreativeID
string
AdminMarketingCreativeMetadata
object
10 properties
10 required
CreativeExportID
string
AdminMarketingCreativeExport
object
10 properties
9 required
AdminMarketingCreative
object
4 properties
4 required
AdminMarketingCreativeList
AdminMarketingCreativeUpload
object
2 properties
2 required
MarketingStillID
string
AdminMarketingStill
One reusable image in the marketing stills library.
AdminMarketingStillList
AdminMarketingStillUpload
object
The image to add to the library, sent as a multipart/form-data body.
2 properties
1 required
AdminMarketingStillUpdate
object
Only the fields present are changed. At least one must be present: an empty body is refused rather than silently restamping the still.
1 property
AdminAdvertisingPlatform
string
Advertising platform.
MarketingAdvertisingCampaignID
string
AdminAdvertisingTargeting
object
Advertising Targeting details.
6 properties
6 required
AdminAdvertisingGoogleCampaign
object
Advertising GoogleCampaign details.
3 properties
1 required
AdminAdvertisingXCampaign
object
Advertising XCampaign details.
2 properties
AdminAdvertisingCampaignVariant
object
Advertising CampaignVariant details.
5 properties
1 required
MarketingAdvertisingGroupID
string
AdminAdvertisingKeyword
object
Advertising Keyword details.
2 properties
AdminAdvertisingGoogleGroup
object
Advertising GoogleGroup details.
3 properties
2 required
AdminAdvertisingRedditGroup
object
Advertising RedditGroup details.
8 properties
2 required
AdminAdvertisingTikTokGroup
object
Advertising TikTokGroup details.
9 properties
2 required
AdminAdvertisingXPlacement
string
Where on X an ad may serve.
AdminAdvertisingXGroup
object
Advertising XGroup details.
7 properties
1 required
AdminAdvertisingGroupVariant
object
Advertising GroupVariant details.
6 properties
2 required
MarketingAdvertisingAdID
string
AdminAdvertisingGoogleAd
object
Advertising GoogleAd details.
4 properties
2 required
MarketingAdvertisingAssetID
string
AdminAdvertisingRedditAd
object
Advertising RedditAd details.
8 properties
AdminAdvertisingTikTokAd
object
Advertising TikTokAd details.
6 properties
AdminAdvertisingXAd
object
Advertising XAd details.
2 properties
AdminAdvertisingAdVariant
object
Advertising AdVariant details.
5 properties
1 required
AdminAdvertisingAd
object
Advertising Ad details.
4 properties
2 required
AdminAdvertisingGroup
object
Advertising Group details.
4 properties
3 required
AdminAdvertisingDraft
object
Advertising Draft details.
5 properties
3 required
AdminAdvertisingReconciliationTarget
object
Advertising ReconciliationTarget details.
5 properties
1 required
AdminAdvertisingReplacement
object
Advertising Replacement details.
5 properties
1 required
MarketingAdvertisingOperationID
string
AdminAdvertisingAction
string
Requested provider action.
AdminAdvertisingIssue
object
Advertising Issue details.
4 properties
AdminAdvertisingAccount
object
Advertising Account details.
8 properties
4 required
AdminAdvertisingSnapshot
object
Advertising Snapshot details.
9 properties
6 required
AdminAdvertisingFact
object
Advertising Fact details.
13 properties
3 required
AdminAdvertisingCampaign
object
Advertising Campaign details.
9 properties
8 required
AdminAdvertisingCampaignList
AdminAdvertisingUpdate
object
2 properties
2 required
AdminAdvertisingCampaignTargetKind
string
Select the campaign hierarchy level.
AdminAdvertisingCampaignTarget
object
Target the campaign for this operation.
1 property
1 required
AdminAdvertisingGroupTargetKind
string
Select the group hierarchy level.
AdminAdvertisingGroupTarget
object
Target the group for this operation.
2 properties
2 required
AdminAdvertisingAdTargetKind
string
Select the ad hierarchy level.
AdminAdvertisingAdTarget
object
Target the ad for this operation.
2 properties
2 required
AdminAdvertisingTarget
Typed selection within the campaign hierarchy.
AdminAdvertisingCheck
object
2 properties
1 required
AdminAdvertisingCheckResult
object
2 properties
2 required
AdminAdvertisingOperationState
string
Durable operation lifecycle state; needsattention requires reconciliation before another provider mutation.
AdminAdvertisingStepState
string
Durable step lifecycle state; needsattention requires reconciliation before another provider mutation.
AdminAdvertisingStepResult
object
Advertising StepResult details.
4 properties
3 required
AdminAdvertisingStep
object
Advertising Step details.
11 properties
5 required
AdminAdvertisingOperation
object
Advertising Operation details.
10 properties
9 required
AdminAdvertisingOperationList
AdminAdvertisingOperationCreate
object
5 properties
3 required
AdminAdvertisingGroupRecord
object
Advertising GroupRecord details.
4 properties
4 required
AdminAdvertisingGroupRecordList
AdminAdvertisingGroupSave
object
3 properties
3 required
AdminAdvertisingAdRecord
object
Advertising AdRecord details.
5 properties
5 required
AdminAdvertisingAdRecordList
AdminAdvertisingAdSave
object
3 properties
3 required
AdminAdvertisingLookupLevel
string
Normalized geographic granularity of a resolved location. Provider vocabularies differ, so each adapter maps its own target type onto these four levels; other…
AdminAdvertisingLookup
object
Advertising Lookup details.
4 properties
AdminAdvertisingAssetUpload
object
2 properties
1 required
AdminAdvertisingAsset
object
Advertising Asset details.
9 properties
7 required
AdminAdvertisingAssetURL
object
1 property
1 required
AdminMarketingAdvertisingMetricKind
string
The advertising resource level. Levels are reported independently.
AdminMarketingAdvertisingMetric
object
11 properties
11 required
AdminMarketingAdvertisingMetricRun
object
4 properties
2 required
AdminMarketingAdvertisingMetricTotal
object
5 properties
5 required
AdminMarketingAdvertisingMetricList
object
3 properties
3 required
AdminAcquisitionKind
string
The event that created this acquisition.
AdminAcquisitionConsent
string
Whether valid consented attribution was present at acquisition.
AdminAcquisitionDeliveryStatus
string
CRM delivery state. Failed inquiries retry daily until expiry; notapplicable covers signups and excluded inquiries.
AcquisitionID
string
AdminAcquisitionTouch
object
11 properties
1 required
AdminAcquisitionSignals
object
7 properties
4 required
DemoConversationStatus
string
open is the initial state after acceptance. qualifying gathers demo requirements. question awaits the requester's question. handoff stops automation and leaves…
AdminAcquisition
AdminAcquisitionList
AdminAcquisitionCampaign
object
16 properties
10 required
AdminAcquisitionReport
object
17 properties
14 required
AdminMarketingPlatform
string
A social network, a search advertising platform, or Bird itself, that a marketing campaign or connection names. Closed: a write is checked against this set, an…
AdminMarketingAdDailyMetric
object
14 properties
14 required
AdminMarketingAdCurrencyTotal
object
6 properties
6 required
AdminMarketingAdReportList
object
2 properties
2 required
PortfolioRevisionID
string
AdminMarketingPortfolioProduct
object
A commercial product shared across advertising channels.
5 properties
5 required
AdminMarketingPortfolioMarket
object
An observed configured country pool; not actual user location.
4 properties
4 required
AdminMarketingPortfolioCampaign
object
Dated campaign identity and planned organization.
7 properties
7 required
AdminMarketingPortfolioAngle
string
Product benefit or MCP angle.
AdminMarketingPortfolioMedium
string
Search text, image, main video or short video. Unknown means no supported creative format is established, including missing or mixed evidence, unmatched rows a…
AdminMarketingPortfolioAudienceRole
string
Prospecting, retargeting or unknown.
AdminMarketingPortfolioBinding
object
A dated classification bound to stable provider IDs.
16 properties
16 required
AdminMarketingPortfolio
object
A complete versioned product catalogue and account organization snapshot.
8 properties
8 required
AdminMarketingPortfolioRevision
object
An accepted organization revision; does not claim Google edits were applied.
3 properties
3 required
AdminMarketingAdWindow
integer
AdminMarketingAdMetricFields
object
9 properties
7 required
AdminMarketingAdMetricBucket
AdminMarketingAdClassificationBasis
string
Product classification inferred from a later URL observation, not verified historical destination evidence.
AdminMarketingAdInferredProduct
AdminMarketingAdSearchBucket
AdminMarketingAdAssetReference
object
2 properties
2 required
AdminMarketingAdCreative
object
8 properties
7 required
AdminMarketingAdLanding
object
12 properties
8 required
AdminMarketingAdReportKind
string
AdminMarketingAdPerformanceSource
object
8 properties
4 required
AdminMarketingAdCampaignRef
object
4 properties
3 required
AdminMarketingAdProviderAsset
object
10 properties
4 required
AdminMarketingAdPerformance
object
29 properties
24 required
AdminMarketingAdReportRun
object
5 properties
2 required
AdminMarketingAdReportRunList
object
1 property
1 required
AdminMarketingSelectableAccount
object
4 properties
4 required
AdminMarketingConnectionProvider
string
A social, advertising, analytics, or Bird platform account authorized through a marketing connection.
AdminMarketingConnectionStatus
string
What the stored credential is worth. accountselectionrequired means consent succeeded but no account is selected; staff can list and select cached accounts unt…
AdminMarketingConnection
AdminMarketingConnectionList
AdminMarketingRedditDestinationKind
string
AdminMarketingRedditFlair
object
3 properties
2 required
AdminMarketingRedditDestinationInfo
object
14 properties
10 required
AdminMarketingBirdAudience
object
2 properties
2 required
AdminMarketingBirdEmailDestinations
object
What a Bird email channel can be pointed at in one connected workspace. An empty list is an answer, not a failure: a workspace with no verified domain cannot s…
2 properties
2 required
AdminMarketingConnectionOAuthStart
object
3 properties
2 required
AdminMarketingConnectionOAuthStartResult
object
3 properties
3 required
AdminMarketingPlatformKind
string
The connection category: social for organic social accounts, search for Google Ads, advertising for other Ads APIs such as Meta Ads, Reddit Ads, TikTok Ads and…
AdminMarketingConnectionPlatform
object
7 properties
6 required
AdminMarketingConnectionPlatformList
object
1 property
1 required
AdminMarketingConnectionGrowthPoint
object
3 properties
3 required
AdminMarketingGrowthStatus
string
Progress of importing the account's historical growth. importing means history is waiting to import or an import is in progress. synced means the latest import…
AdminMarketingConnectionGrowthSeries
object
13 properties
13 required
AdminMarketingConnectionGrowthList
object
1 property
1 required
AdminMarketingConnectionAudiencePoint
object
2 properties
2 required
AdminMarketingConnectionAudienceSeries
object
7 properties
7 required
AdminMarketingConnectionAudienceList
object
1 property
1 required
AdminCountryPolicyUpsert
object
8 properties
AdminSMSKeywordOperation
string
What the catalogue row's keywords do. - stop opens a suppression episode on the (sender, subscriber) pair, then sends the acknowledgement reply. - start ends t…
SMSSystemKeywordRuleID
string
AdminSMSKeywordRule
object
10 properties
7 required
AdminSMSKeywordRuleList
object
2 properties
2 required
AdminSMSKeywordRuleUpsert
object
Creates or replaces one catalogue row, keyed by (country, language, operation). That triple is the identity: two rows sharing it would derive identical keyword…
7 properties
3 required
AdminPlatformPolicyUpsert
object
23 properties
1 required
AdminSenderTypePolicy
object
The complete sender type policy for one country, platform, and sender type. Unlike the messaging context, this carries the staff-only fields as well, so an edi…
22 properties
15 required
AdminSenderTypePolicyUpsert
object
17 properties
3 required
BillingProductList
object
1 property
1 required
BillingEntitlementRateCard
object
2 properties
2 required
BillingPlanEntitlement
object
3 properties
1 required
BillingPlanQuota
object
2 properties
2 required
BillingPlan
object
9 properties
8 required
BillingPlanList
object
1 property
1 required
BillingPriceContext
object
What else you need to know before relying on this price, such as whether the destination accepts only a sender you have registered. Absent when nothing further…
1 property
BillingPrice
object
4 properties
2 required
BillingPriceList
object
1 property
1 required
BillingSubscriptionBase
object
Fields shared by every subscription, whether it is a plan or a unit subscription.
12 properties
10 required
BillingPlanSubscription
A plan subscription with plan-specific detail.
CreatePlanSubscription
object
1 property
1 required
ChangePlan
object
1 property
1 required
BillingPlanChangeResult
object
6 properties
2 required
BillingPendingOperation
object
13 properties
9 required
BillingPendingOperationList
object
1 property
1 required
BillingSubscription
A plan or unit subscription with its resolved price.
BillingSubscriptionList
object
1 property
1 required
UsageBreakdownType
string
A usage breakdown dimension. - daily: per-day buckets. - country: per-country breakdown (rate-card products only). - domain: per-sending-domain breakdown (emai…
BillingPricingModel
string
How this product is priced. - plan: it comes with the organization's subscribed plan, with usage tracked against that plan's included allowance. - metered: it…
BillingInterval
string
The recurring interval one subscription charge covers.
BillingResolvedPrice
object
12 properties
8 required
BillingWalletCollectionStatus
string
Automatic collection state: - none: No retained collection run. - inprogress: Collection is active, though payment may still require customer action. - exhaust…
BillingWallet
object
15 properties
15 required
BillingWalletList
object
1 property
1 required
BillingWalletUpdate
object
1 property
1 required
PaymentMethodType
string
Payment method for a wallet top-up. card completes without leaving the page. applepay and googlepay complete on the page too, but only where the payer's browse…
BillingPaymentMethodOffer
object
4 properties
3 required
BillingPaymentMethodList
object
1 property
1 required
BillingPaymentIntentStatus
string
Where this payment is in its lifecycle. - pending: there is no attempt outcome yet. - requiresaction: it needs an additional step, such as authentication, befo…
BillingWalletPaymentIntentStatus
object
The owner's view of an in-flight or settled payment. Deliberately carries no client secret: unlike BillingPaymentIntent, this is a status read rather than a cr…
4 properties
2 required
WalletTopup
object
2 properties
1 required
BillingPaymentIntent
object
8 properties
5 required
BillingWalletTransaction
object
11 properties
6 required
BillingWalletTransactionList
BillingCurrency
object
5 properties
5 required
BillingCurrencyList
object
1 property
1 required
BillingInvoice
object
A billing invoice issued to the organization.
15 properties
12 required
BillingInvoiceList
BillingInvoiceDetail
object
An invoice with its line items.
BillingPaymentConsent
object
8 properties
6 required
BillingPaymentConsentList
BillingPaymentConsentUpdate
object
1 property
BillingPaymentConsentSetup
object
4 properties
4 required
BillingPaymentReceipt
object
A receipt for a wallet top-up payment.
9 properties
6 required
BillingPaymentReceiptList
BillingProformaDocument
object
A prepayment request for a wallet top-up. Not a tax invoice.
5 properties
5 required
BillingProformaDocumentList
BillingProformaDocumentCreate
object
Request to create a pro forma document for a wallet prepayment.
1 property
1 required
BillingTaxProfile
object
The organization's tax profile. Returns default values (taxcountry=null, taxtype=none, taxrate=0, taxnumberstatus=none) if no profile has been configured.
11 properties
5 required
BillingOverageStatus
string
The organization's effective overage posture: - billed: usage past the plan's included volume is billed per unit. - cappedbypreference: the organization turned…
BillingNotificationSettings
object
An organization's wallet notification settings: automatic top-up configuration and the low-balance alert threshold. Returns default values (autotopupenabled=fa…
9 properties
4 required
BillingNotificationSettingsUpdate
object
Fields to update on the organization's wallet notification settings. Omit a field to leave it unchanged; send null to clear it. When autotopupenabled is true,…
6 properties
PlatformCurrency
object
4 properties
4 required
PlatformCurrencyList
object
1 property
1 required
PlatformCountry
object
2 properties
2 required
PlatformCountryList
object
1 property
1 required
DemoRequest
object
6 properties
2 required
DemoContactValidationRequest
object
2 properties
2 required
DemoContactStatus
string
Whether the contact is suitable, unsuitable, or could not be confirmed.
DemoContactCheck
object
3 properties
1 required
DemoContactValidation
object
3 properties
3 required
DemoConversationRequest
object
8 properties
5 required
DemoConversationChannel
string
Channel carrying the conversation message.
DemoConversationDirection
string
Whether the requester or Bird sent the conversation message.
DemoConversationMessageState
string
Current delivery or transcript state: - queued: waiting for a send attempt or channel readiness. - ambiguous: provider acceptance could not be confirmed; recon…
DemoConversationMessage
object
6 properties
6 required
DemoConversation
object
7 properties
7 required
DemoConversationAcceptance
object
3 properties
3 required
DemoConversationReplyRequest
object
2 properties
2 required
SIPTrunkID
string
SIPTrunkACLID
string
VoiceTrunkIPACL
object
5 properties
4 required
VoiceSIPDigestAlgorithm
string
A hash algorithm for SIP Digest authentication, spelled as it appears in the algorithm= parameter on the wire. SHA-256 is the stronger option and is offered fi…
VoiceTrunkCore
object
A SIP trunk's identity and access-control settings.
12 properties
12 required
VoiceTrunkRouting
object
Whether the trunk's workspace can currently route outbound calls.
1 property
1 required
VoiceTrunk
VoiceTrunkList
VoiceTrunkCreate
object
6 properties
1 required
VoiceTrunkIPACLCreate
object
2 properties
1 required
VoiceTrunkUpdate
object
A change to the trunk's directions, name, access control, and Digest algorithm offer. Every field is optional. An omitted field is left unchanged. The ipacls,…
8 properties
VoiceSessionCredential
object
A short-lived SIP digest credential for a calling client. The password is returned once and cannot be recovered. Create a new credential if you lose it.
5 properties
4 required
VoiceTrunkGatewayID
string
VoiceTrunkGateway
One address an inbound call to this trunk is forwarded to, and how that peer wants the call's two numbers spelled. A trunk can have several, tried in priority…
VoiceTrunkGatewayList
object
The trunk's gateways. Not paginated: a trunk holds a small, hand-managed set of dial targets, and the order across the whole set is what decides hunt order, so…
1 property
1 required
VoiceTrunkGatewayCreate
object
4 properties
2 required
VoiceTrunkGatewayUpdate
object
A change to the gateway's address, its place in the order, or how it wants numbers spelled. Every field is optional; an omitted field is left unchanged.
4 properties
VoiceNumberID
string
VoiceNumberProviderType
string
Where a number came from. allocation is a number we allocated to your workspace, and the only kind whose calls reach us. verifiednumber is a number from anothe…
VoiceNumberProviderAllocation
object
2 properties
2 required
VoiceCallerIDStatus
string
Verification state of the caller ID. - pending: the number is registered but ownership has not yet been proven. - verified: the workspace completed the verific…
VoiceNumberProviderVerifiedNumber
object
3 properties
3 required
VoiceNumberProvider
Where this number came from, and the facts that belong to that answer. The type selects the shape. allocation is a number we allocated to your workspace, and i…
VoiceNumberDirections
object
2 properties
2 required
VoiceInboundConfigurationError
string
VoiceCallRouteType
string
Which answer a number carries. - reject: refuses the call. This is where every number starts. - trunk: delivers the call to one of your SIP trunks. - forward:…
VoiceCallRouteReject
object
1 property
1 required
VoiceCallRouteTrunk
object
2 properties
2 required
VoiceInboundForwardAs
string
Which of a forwarded call's two numbers it shows as the caller. "dialednumber" is the number the caller dialled, which is one of yours. Carriers treat it as fu…
VoiceCallRouteForward
object
3 properties
3 required
VoiceSequenceSlug
string
Slugs starting with bird are reserved for builtin sequences. You can reference these sequences but cannot create, edit, rename, or delete them.
VoiceCallRouteSequence
object
2 properties
2 required
VoiceCallRoute
What happens to a call arriving for this number. The type selects the shape: "reject" refuses the call, "trunk" delivers it to one of your SIP trunks, and "for…
VoiceInboundConfiguration
object
3 properties
1 required
VoiceNumber
object
8 properties
8 required
VoiceNumberList
VoiceInboundConfigurationPut
object
1 property
1 required
VoiceNumberUpdate
object
2 properties
VoiceCallerIDID
string
VoiceCallerID
VoiceCallerIDList
VoiceCallerIDCreate
object
2 properties
1 required
VoiceCallerIDUpdate
object
A change to the caller ID's label. Every field is optional; an omitted field is left unchanged.
1 property
VoiceCallerIDVerifyRequest
object
1 property
1 required
AdminVoiceRoutingExpressionValidation
object
2 properties
2 required
AdminVoiceCallFlowProbeCall
object
6 properties
1 required
AdminVoiceRoutingRuleAction
string
What a matching call does. route sends it to the rule's interconnects; block refuses it (a destination ban). Matching is strict either way: a matched blocking…
AdminVoiceRoutingRuleExpression
string
Expression the call must satisfy for this rule to match, written in [CEL](https://github.com/google/cel-spec). It must produce true or false; true matches ever…
AdminVoiceCallFlowProbeRule
object
One rule as it stands in the editor, saved or not. The probe evaluates the set in priority order and stops at the first match, so what it reports is what the p…
4 properties
1 required
AdminVoiceCallFlowProbe
object
3 properties
1 required
AdminVoiceCallFlowRefusalReason
stringnull
Why the call would be refused before any rule was consulted, as a code the editor can branch on. unclassifiabledestination covers a number that cannot be parse…
AdminVoiceCallSourceFacts
object
The calling end, as a rule expression addresses it. Absence is null on every field here; a rule expression sees the same absence as the EMPTY STRING, which is…
6 properties
6 required
AdminVoiceDestinationNetwork
string
Destination allocation network used by routing expressions. - public: no Bird allocation region was established within the lookup budget. - birdeu1: an allocat…
AdminVoiceCallEndpointFacts
object
The dialled end, as a rule expression addresses it. Number, country and type represent absence as null; an expression sees the same absence as an empty string.…
4 properties
4 required
AdminVoiceCallRelationFacts
object
The relation between the two ends of the call, as a rule expression addresses it.
2 properties
2 required
AdminVoiceCallFacts
object
The facts a routing-rule expression is evaluated against, in the three namespaces it addresses them by.
3 properties
3 required
AdminVoiceCallFlowPrice
object
3 properties
2 required
AdminVoiceCallFlowVerdict
string
matched is the rule that decides the call; notmatched was evaluated and did not apply; notreached sits after the match, so first-match-wins never consulted it;…
AdminVoiceCallFlowRuleVerdict
object
What one rule did about one call.
4 properties
4 required
AdminVoiceCallFlowFinalAction
string
What would happen to the call. route and block are the matching rule's own action. refused means no rule decided it: an unclassifiable destination, a rule that…
AdminVoiceCallFlowProbeCallResult
object
10 properties
8 required
AdminVoiceCallFlowProbeResult
object
1 property
1 required
AdminVoiceSampleNumbers
object
1 property
1 required
AdminVoiceGatewayLatencyTransport
string
Transport to time the gateway over. Not nullable, unlike a stored gateway's transport: a null there means RFC 3263 resolution picks, and this probe dials one t…
AdminVoiceGatewayLatencyTarget
object
One gateway to time, addressed exactly as a call would address it. Every field is required, including the two that may be null: a caller states the port and tr…
3 properties
3 required
AdminVoiceGatewayLatencyProbe
object
The gateways to time. They travel in the request rather than being read from a routing version, so an editing session can be timed before it is saved, and a re…
1 property
1 required
AdminVoiceGatewayLatencyMeasurement
object
One gateway's round trip as this region measured it. gateway echoes the request entry, so a caller attributes a measurement by address rather than by position.…
4 properties
4 required
AdminVoiceGatewayLatencyProbeResult
object
What this region measured for each requested gateway.
1 property
1 required
AdminVoiceNumberFacts
object
The facts a workspace sees about its own number. Duplicated from VoiceNumber rather than shared: that schema is published and flat, so it can be neither compos…
8 properties
8 required
AdminVoiceSIPTrunkStatus
string
Where the supplier-side trunk attachment for a number has got to.
AdminVoiceSIPTrunkState
object
What Bird believes it configured at the supplier for this number, as the reconciler last recorded it.
4 properties
2 required
AdminVoiceNumberInternals
object
What staff see about a voice number beyond what its workspace sees: which workspace holds it, how far proving control of it got, and the state of the trunk reg…
5 properties
2 required
AdminVoiceNumber
Staff view of one voice number: everything its workspace sees about it, plus the workspace holding it and the facts a customer never does.
AdminVoiceNumberList
AdminVoiceTrunk
Staff view of a customer's SIP trunk: the owning tenant, the Bird-assigned wire domain, and the two allow lists that gate SIP traffic on it.
AdminVoiceTrunkList
AdminVoiceTrunkCreate
object
Provisions a SIP trunk on a customer's behalf. The trunk's wire domain is assigned by Bird and the owning organization is taken from the workspace, so neither…
4 properties
2 required
AdminVoiceTrunkDetail
object
Staff view of a single SIP trunk, adding whether the workspace can currently route outbound calls, the second half of "why is this customer's trunk not working…
VoiceSigningCredID
string
AdminVoiceSigningRegime
string
The attestation authority a signing credential answers to. It decides the trust anchor a certificate must chain to and, on every signed call, which classifier…
AdminVoiceSigningCredential
AdminVoiceSigningCredentialList
AdminVoiceSigningCredentialCreate
object
6 properties
6 required
AdminVoiceSigningCheckName
string
Which upload check this is. Open enum: the set of checks grows as more of them become worth running before a certificate signs anything, so treat an unrecogniz…
AdminVoiceSigningCheckStatus
string
The check's outcome. A status of skipped means the check could not run, today only the chain check where the regime has no trust anchors configured.
AdminVoiceSigningCheck
object
3 properties
2 required
AdminVoiceSigningCredentialCreateResult
object
2 properties
2 required
VoiceAttestationPolicyID
string
AdminVoiceAttestationPolicy
AdminVoiceAttestationPolicyList
object
1 property
1 required
AdminVoiceAttestationPolicyCreate
object
3 properties
3 required
VoiceLimitProfileID
string
AdminVoiceLimitProfile
AdminVoiceLimitProfileList
AdminVoiceLimitProfileCreate
object
5 properties
2 required
AdminVoiceLimitProfileUpdate
object
4 properties
AdminVoiceCaptureWindow
object
The time range to inspect, including its start and excluding its end.
2 properties
2 required
AdminVoiceCaptureProfile
string
SIP capture profile to search: - 1call: SIP call signalling. - 1registration: SIP registration messages. - 1default: Other SIP messages, including high-volume…
AdminVoiceCaptureFilters
object
Exact-match capture filters. All supplied filters must match.
10 properties
AdminVoiceCaptureSearchRequest
object
Search one capture profile, or supply callid to return the complete correlated selection, within an explicit time range of at most 24 hours.
4 properties
1 required
AdminVoiceCapture
object
A captured SIP message, quality report, or log record. Filtered search omits raw; correlated search includes it.
9 properties
7 required
AdminVoiceCaptureRegion
object
Whether one region answered the capture request.
2 properties
2 required
AdminVoiceCaptureSearchResult
object
A page of capture records from the serving region. A failed region is reported explicitly even when the page is empty.
AdminVoiceCaptureExportFormat
string
Pcapng includes reconstruction provenance. Classic pcap supports older recipient tools but cannot include those comments. Text includes the correlated records…
AdminVoiceCaptureExportRequest
object
Export a Call-ID within an explicit time range of at most 24 hours.
4 properties
2 required
AdminVoiceVerificationCallerID
AdminVoiceVerificationCallerIDList
object
1 property
1 required
AdminVoiceVerificationCallerIDUpsert
object
2 properties
1 required
VoiceCallRejectionReason
string
Why we rejected the call. Use rejectionreason to identify the cause; sipresponsecode alone cannot distinguish these reasons. You can resolve these issues: - so…
VoiceCallInboundRouteReject
object
1 property
1 required
VoiceCallInboundRouteTrunk
object
2 properties
2 required
VoiceCallInboundRouteForward
object
3 properties
3 required
VoiceCallInboundRoute
The routing choice recorded for an incoming call. A recorded route does not guarantee that the call connected. Check status for the outcome and rejectionreason…
VoiceMediaQuality
object
4 properties
4 required
VoiceCallCost
object
What was charged for a call, split into the components that make it up.
7 properties
7 required
AdminVoiceCallUnbilledReason
string
Why the platform deliberately did not charge this call. Absent on every call that billed normally, which is all of them but the ones Bird itself causes. - plat…
AdminVoiceCall
object
25 properties
9 required
AdminVoiceCallList
AdminVoiceCallsStatsVolume
object
3 properties
3 required
AdminVoiceCallsStatsTotals
AdminVoiceCallsStatsPoint
AdminVoiceCallsStatsCarrier
AdminVoiceCallsStatsSipCode
object
One final SIP response code and how much of the period's traffic ended on it. This is the breakdown that answers why calls failed.
3 properties
3 required
AdminVoiceCallsStatsWorkspace
AdminVoiceCallsStats
object
Cross-workspace voice call statistics for a period, with the equal-length period before it for comparison, a daily series, and the per-carrier, per-SIP-respons…
11 properties
11 required
AdminVoiceCallCorrelation
object
The identifiers other systems index this call by, so a record here can be matched to the platform's logs and traces, and to what the carrier saw. These are the…
3 properties
1 required
AdminVoiceCallEdge
string
Which border listener the call arrived on. sip is a SIP peer (a customer trunk, or a numbers provider delivering a DID call) and webrtc is a browser client. Op…
AdminVoiceCallSource
string
Which Bird product asked for this call. verify is a one-time-passcode leg the platform placed on the workspace's behalf. Open enum: each product that starts pl…
AdminVoiceCallShakenAttestation
string
How much the platform is willing to vouch for the caller identity it signed, and the level it put in the PASSporT. - A: the caller's right to present that numb…
AdminVoiceCallInternals
object
The internal facts about a call leg that no customer surface carries. Everything here is recorded for operating the platform: how the call arrived, where it wa…
9 properties
1 required
AdminVoiceCallLeg
object
One call leg with everything the platform recorded about it, customer-visible and internal alike. The leg is the unit: a transferred or bridged call is several…
AdminVoiceCallDetail
object
Staff view of one call for troubleshooting: the leg that was asked for, with all of its internal facts, alongside the other legs of the same call. Both sides c…
2 properties
2 required
VoiceBreakoutVersionID
string
AdminVoiceBreakoutInactiveReason
string
Why the platform could not finish placing this row. retiredprefix means the prefix uses a numbering form the country has withdrawn, so no live call can match i…
VoiceBreakoutCodeID
string
AdminVoiceBreakoutLabel
string
The destination label this prefix breaks out to, as it appears in the vendor's destination-name column. Many prefixes share one label, which is how a rule can…
AdminVoiceBreakoutNumberType
string
The destination class calls under this code reach, and half of the key customers are quoted on: a published rate is meaningless without knowing whether it pric…
AdminVoiceBreakoutStatus
string
Whether this row is used to classify calls. Inactive rows stay listed and searchable but classify nothing, which is how a row the platform could not fully plac…
AdminVoiceBreakoutCode
AdminVoiceBreakoutCodeList
AdminVoiceBreakoutVersion
AdminVoiceBreakoutVersionList
object
1 property
1 required
AdminVoiceBreakoutVersionCreate
object
1 property
1 required
AdminVoiceBreakoutRowOp
object
6 properties
2 required
AdminVoiceBreakoutOps
object
A batch of edits to one draft, applied in a single transaction so a save that both changes and removes rows cannot half-apply. Rows are keyed on breakoutcode,…
3 properties
AdminVoiceBreakoutInactiveCount
object
3 properties
3 required
AdminVoiceBreakoutImportResult
object
7 properties
7 required
AdminVoiceBreakoutDiffRow
object
One code's before and after between two versions.
4 properties
2 required
AdminVoiceBreakoutDiff
object
What publishing this draft would change, against the deck currently live. The counts are exact and the sample is capped, because the decision rests on the shap…
5 properties
5 required
VoiceRoutingVersionID
string
AdminVoiceRoutingVersionStatus
string
draft is the only editable state. active is the graph every cell routes with, and exactly one version is active at a time. superseded was live and has been rep…
AdminVoiceRoutingVersion
AdminVoiceRoutingVersionList
object
1 property
1 required
AdminVoiceRoutingVersionCreate
object
1 property
1 required
AdminVoiceRoutingVersionImport
object
2 properties
2 required
AdminVoiceRoutingVersionUpdate
object
1 property
1 required
AdminVoiceRoutingSlug
string
Name of a routing table, carrier or credential as rules and gateways reference it: lowercase words joined by single underscores, the same grammar as a supplier…
AdminVoiceRoutingDiffChange
string
How activating the version would move this entry relative to the active one.
AdminVoiceRoutingDiffEntry
object
2 properties
2 required
AdminVoiceRoutingProblem
object
One thing wrong with the graph the draft now holds. A draft accepts these rather than refusing them: an operator builds a graph one rule at a time and the half…
2 properties
2 required
AdminVoiceRoutingVersionDiff
object
What activating a version would change against the active one, by slug, and what would refuse it. Read the two versions' tables and carriers for the detail; th…
6 properties
6 required
AdminVoiceRoutingSourceType
string
Call origin: verify for Verify OTP calls, voiceforward for platform forwarding, or empty for ordinary SIP trunk calls.
AdminVoiceCarrierRegion
string
The cell a call is routed in. A rule never names a region; the cell routing the call reads its own entry of the group's regions.
AdminVoiceRoutingProbe
object
7 properties
2 required
AdminVoiceRoutingProbeOrigFacts
object
The orig namespace as the rules saw it. Every field empties together when the caller ID is not presentable, so an absent value is the empty string and the prop…
6 properties
AdminVoiceRoutingProbeDestFacts
object
The dest namespace as the rules saw it.
4 properties
1 required
AdminVoiceRoutingProbeCallFacts
object
The call namespace as the rules saw it. An absent value is the empty string.
8 properties
AdminVoiceRoutingProbeFacts
object
The facts as the rules saw them, by namespace.
3 properties
3 required
VoiceRoutingRuleID
string
AdminVoiceRoutingProbeVerdict
string
A matched table rule descended; the steps that follow are inside the table it named until evaluation resumes.
AdminVoiceRoutingProbeStep
object
3 properties
3 required
AdminVoiceRoutingProbeFinalAction
string
route with the matched rule's carriers, block on a matched block rule, and refused when nothing matched, an expression failed to evaluate, or the destination w…
AdminVoiceCarrierOutboundRef
string
One carrier's outbound group as a rule names it: the carrier slug, a colon, then the group slug, each of them a routing slug. Both halves are required, so addi…
AdminVoiceRoutingProbeCarrier
object
One rung of the matched route rule's carrier ladder, in hunt order.
2 properties
2 required
AdminVoiceRoutingProbeCallResult
object
9 properties
5 required
AdminVoiceRoutingProbeResult
object
1 property
1 required
AdminVoiceRoutingGraphRuleAction
string
What a matching call does. route sends it to the rule's carriers in preference order; block refuses it; table descends into another table, where a match is ter…
AdminVoiceRoutingGraphRuleExpression
string
Expression the call must satisfy for this rule to match, in the CEL dialect AdminVoiceRoutingRuleExpression documents in full. Unlike a dial plan's it is optio…
AdminVoiceRoutingRuleLabel
stringnull
An operator's note on why this rule exists: who asked for it, what it is working around. CEL carries no comments, and a first-match-wins table gets its meaning…
AdminVoiceRoutingCarrierRef
object
One rung of the ladder. Its position in the list is its place in the hunt: the border dials the first rung with gateways in the serving region, skips any rung…
1 property
1 required
AdminVoiceRoutingGraphRule
object
7 properties
3 required
AdminVoiceRoutingTable
AdminVoiceRoutingTableList
object
1 property
1 required
AdminVoiceRoutingGraphRuleWrite
object
One rule as it should stand after the write. The payload follows the action: route carries carriers, table carries a table, block neither; a write that contrad…
7 properties
2 required
AdminVoiceRoutingTableWrite
object
3 properties
2 required
AdminVoiceRoutingTableWriteResult
object
3 properties
3 required
AdminVoiceRoutingTableRename
object
The slug to move to, and the token the row was read with. The rename and the repointing of every rule that descended into the old slug are one transaction, so…
2 properties
1 required
AdminVoiceRoutingDiscardResult
object
3 properties
3 required
AdminVoiceCarrierInbound
object
How this carrier's traffic is admitted, wherever it arrives. Each field is a method and presence is the switch: cidrs admits by source address, credential admi…
2 properties
AdminVoiceCarrierGatewayTransport
stringnull
SIP transport for the outbound leg. Null lets RFC 3263 resolution decide.
AdminVoiceCarrierGateway
object
One dialable endpoint, the same wherever Bird dials it; which regions dial it, and in what order, is its group's regions. Two gateways that would dial the same…
7 properties
3 required
AdminVoiceRegionGatewayEntry
object
One gateway's place in one region's list. gateway is its index in the enclosing outbound group's gateways. Lower priority is tried first; gateways sharing a pr…
3 properties
3 required
AdminVoiceCarrierRegionConfig
object
The outbound group's delivery settings for one originating region. Drafts may retain conflicting delivery settings as validation problems. The server enforces…
2 properties
1 required
AdminVoiceCarrierOutbound
object
One addressable set of a carrier's gateways, with the gateways each region dials out of it. A rule names this group as : ; a carrier with a single group slugs…
4 properties
4 required
AdminVoiceCarrier
AdminVoiceCarrierList
object
1 property
1 required
AdminVoiceCarrierWrite
object
5 properties
3 required
AdminVoiceCarrierWriteResult
object
2 properties
2 required
AdminVoiceCarrierRename
object
The slug to move to, and the token the row was read with. Shared by the carrier and outbound-group renames: what moves is whichever slug the path names. The re…
2 properties
1 required
AdminVoiceCarrierCredential
AdminVoiceCarrierCredentialList
object
1 property
1 required
AdminVoiceCarrierCredentialWrite
object
2 properties
1 required
EsimSupplierID
string
AdminEsimSupplierState
string
Registry state of a supplier. - active: eligible for new-order routing. - degraded: temporarily removed from routing by drift or health signals; existing eSIMs…
AdminEsimSupplier
AdminEsimSupplierList
object
1 property
1 required
AdminEsimSupplierCreate
object
Registers a supplier. It starts with every capability unknown and cannot serve orders until its capabilities are declared and it is activated.
6 properties
4 required
AdminEsimSupplierUpdate
object
Fields that can change on a supplier. State transitions are validated; retiring requires no bindings with unexpired packages.
5 properties
AdminEsimIssuanceModel
string
How the supplier delivers a profile: synchronous (minted in the API response, so orders complete inline), callback (acknowledged now, delivered asynchronously)…
AdminEsimEndUserIdentity
string
What the supplier requires about the person behind an eSIM. - none: no end-user data required; guest checkout works. - email: an end-user record with an email…
AdminEsimCapabilityValue
string
Declared capability answer. There are no defaults; unknown means the supplier has not stated it, and an unknown capability is never sold against.
AdminEsimSupplierMsisdn
string
Whether a subscription comes with a phone number (MSISDN). always means every subscription carries one; optional means the vendor attaches one on request per s…
AdminEsimUsageFeed
string
How the supplier reports usage, which bounds how fresh balances and usage records can be. none means the supplier keeps no queryable usage history at all; eSIM…
AdminEsimSupplierCapabilities
object
The supplier's declared capability descriptor. Every field is stated explicitly or declared unknown; nothing defaults. Routing only offers what a supplier has…
26 properties
26 required
EsimZoneID
string
AdminEsimPoolSegment
object
One segment of a supplier's profile stock. Stock that is not zone-specific reports as a single segment with a null zone.
5 properties
5 required
AdminEsimSupplierPool
object
The maintained stock of pre-purchased profiles for a stock-issuance supplier. Orders are served from this pool; replenishment purchases happen on the supplier'…
5 properties
5 required
AdminEsimPoolZoneTarget
object
Per-zone override of the pool's target and alert threshold.
3 properties
3 required
AdminEsimSupplierPoolUpdate
object
Full statement of the pool's maintenance configuration. Zone overrides replace the stored set; a zone absent from the list falls back to the defaults.
3 properties
2 required
AdminEsimPoolProfileStatus
string
Where one pre-purchased ICCID stands in Bird's inventory. Only the first two count as stock. - available: unused, ready to serve an order. - reserved: held by…
AdminEsimPoolProfile
object
One pre-purchased ICCID in a stock supplier's pool: the row a reservation draws and the counts in the pool read are derived from. Identified by the ICCID itsel…
4 properties
4 required
AdminEsimPoolProfilePage
AdminEsimPoolProfileStatusUpdate
string
The one profile state an operator may set by hand. reserved and assigned belong to the order engine, and quarantined cannot be undone: a withdrawn card may alr…
AdminEsimPoolProfileUpdate
object
A correction to one recorded profile. Name at least one field; a field left out is left as it is.
2 properties
AdminEsimSupplierPoolWithdrawalCreate
object
A batch of recorded ICCIDs to withdraw from the pool for good.
1 property
1 required
AdminEsimSupplierPoolWithdrawalResult
object
What one withdrawal batch changed. The split is the point: a batch that withdrew nothing named cards the order engine holds, cards already withdrawn, or anothe…
3 properties
3 required
AdminEsimSupplierPoolStockCreate
object
A batch of pre-purchased ICCIDs to take into the pool.
2 properties
1 required
AdminEsimSupplierPoolStockResult
object
What one intake batch changed. The two counts are taken over the batch's distinct ICCIDs, so they sum to fewer than the ICCIDs sent when the batch repeated one.
3 properties
3 required
EsimRoutingPolicyID
string
AdminEsimRoutingPolicyMode
string
How the policy steers supplier selection. - pin: always route to the named supplier when it can serve; fall back to the cost ranking when it cannot. - prefer:…
AdminEsimRoutingPolicy
AdminEsimRoutingPolicyList
object
1 property
1 required
AdminEsimRoutingPolicyCreate
object
Creates a routing policy for one zone. For country-grain control, target a single-country zone.
7 properties
4 required
AdminEsimRoutingPolicyUpdate
object
Fields that can change on a routing policy. The zone is immutable; create a new policy to re-scope.
6 properties
AdminEsimRoutingTest
object
Dry-run the supplier selection an order for this offer would make right now. Nothing is ordered or charged.
2 properties
1 required
AdminEsimRoutingExclusionReason
string
Why a supplier was filtered out of a routing decision before ranking. The set is stable: reasons are recorded on every decision and read back months later. - s…
AdminEsimRoutingCandidate
object
One supplier's evaluation in a routing decision, in ranking order.
7 properties
5 required
AdminEsimRoutingAppliedPolicy
object
The rule that decided the outcome, snapshotted from the evaluation itself rather than joined against today's policy list: the policy may have been edited or de…
3 properties
3 required
AdminEsimRoutingTestResult
object
The reproducible routing decision, with every candidate's evaluation and the rule that decided it.
2 properties
2 required
AdminEsimRoutingDecision
object
One routing decision, exactly as recorded when an order was routed: the winning supplier, every candidate's evaluation, and the policy rule that decided, snaps…
8 properties
8 required
EsimZoneType
string
Zone breadth: a single country, a multi-country region, or worldwide.
AdminEsimZoneStatus
string
Whether the zone is promoted. - active: the zone's offers appear in the customer catalog and accept new orders. - disabled: the zone is withdrawn. Its offers l…
AdminEsimZone
object
Staff view of a coverage zone: the customer shape plus the promotion status. The status is staff-only wire state, because customers only ever see promoted zone…
7 properties
7 required
AdminEsimZoneList
object
1 property
1 required
AdminEsimZoneCreate
object
Creates a coverage zone at revision 1. The country list is the product guarantee every offer selling this zone inherits.
3 properties
3 required
AdminEsimZoneUpdate
object
Changes a zone. Any change to the country list bumps the zone's revision, making the coverage change observable to customers.
4 properties
AdminEsimOfferPricingType
string
Commercial shape of an offer's terms. - bundle: a fixed allowance with a validity period.
EsimSpeed
string
Speed class. full: data flows at full network speed until the allowance is used; reduced: speed is limited, typically after the full-speed allowance. Full-spee…
AdminEsimOfferTerms
object
What a package sold from this offer delivers. They carry no money: the price a customer sees is the resolved rate of the offer's billing product. Routing serve…
3 properties
2 required
EsimOfferStatus
string
Availability of an offer. - draft: being curated; never returned on the customer surface and not purchasable. - active: purchasable. - retired: no longer purch…
AdminEsimOfferBase
object
Staff view of a catalog offer. Deliberately not the customer offer: that one carries a price resolved for the calling workspace, and an admin request has no wo…
11 properties
11 required
AdminEsimOfferSummary
Compact offer row for staff lists, being the offer without its embedded coverage zone. Fetch the offer or the zone for the country list.
AdminEsimOfferList
object
1 property
1 required
AdminEsimOfferCreate
object
Creates an offer at revision 1, in draft status until activated via update. The offer carries no money amount: it names the billing product whose workspace-res…
8 properties
7 required
EsimZone
object
A coverage footprint: the set of countries eSIM service works in. Zones are curated centrally and shared by every offer selling the same footprint, so coverage…
6 properties
6 required
AdminEsimOffer
AdminEsimOfferUpdate
object
Changes an offer. Any change to commercial terms bumps the offer's revision; in-flight orders keep the revision they locked.
5 properties
AdminEsimOfferBacking
AdminEsimOfferBackingList
object
1 property
1 required
AdminEsimOfferBackingUpsert
object
Sets or replaces this supplier's backing for the offer.
3 properties
2 required
EsimStatus
string
Lifecycle state of an eSIM. A pending state always settles: to its target on success, or back to the prior status when the network definitively rejects the cha…
EsimInstallation
object
Device-side installation state of the eSIM profile.
3 properties
1 required
EsimPackageStatus
string
Lifecycle state of a data package. - provisioning: being applied to the eSIM. - pendingfirstuse: confirmed; activates on first use in its coverage zone. - acti…
EsimPackageBalance
object
Remaining balance of a data package. Balances update as usage is reported by mobile networks and can trail live usage: asof tells you how fresh the numbers are.
5 properties
5 required
EsimPackage
object
One data package held by an eSIM: a single purchase with its own balance, validity, and coverage zone. Every order that completes creates exactly one package,…
13 properties
11 required
EsimZoneBalance
object
Remaining data for one coverage zone, combined across the eSIM's packages for that zone. Zones can overlap in a country; entries are per zone, not per country,…
5 properties
5 required
EsimNetworkAttachment
object
The most recent mobile network the device attached to.
4 properties
2 required
Esim
AdminEsim
object
Staff view of an eSIM, for cross-workspace support lookup. Adds what the customer surface deliberately hides, the workspace and the serving supplier.
3 properties
3 required
AdminEsimPage
AdminEsimRelease
object
Staff release of an eSIM.
2 properties
1 required
EsimOrderStatus
string
Order state. - scheduled: accepted to run at a future time; nothing has been charged. - charging: securing funds for the quoted price. An order the wallet cann…
EsimDelivery
object
Where and how install credentials reach the traveler. The recipient is a raw address, so delivery works for travelers who are not stored anywhere: an email add…
3 properties
2 required
EsimOrderFunding
object
Why the order is parked in charging and what unblocks it. The wallet could not fund the last charge attempt; top up the wallet (or retry once funds arrive) and…
2 properties
2 required
EsimOrder
AdminEsimOrder
object
Staff view of an order, with the workspace and routing outcome the customer surface hides.
5 properties
5 required
AdminEsimOrderPage
AdminEsimOrderCancel
object
Staff resolution of a stuck order.
1 property
1 required
AdminEsimCommandStatus
string
Outcome of a journaled supplier command. - pending: issued, no outcome yet. - succeeded: the supplier confirmed the effect. - failed: the supplier definitively…
AdminEsimCommandKind
string
Which port operation was issued. Open enum: new command kinds appear as the port grows.
EsimSupplierCommandID
string
AdminEsimCommand
AdminEsimCommandPage
VoiceCall
object
21 properties
7 required
VoiceCallList
VoiceSequencePhoneNumber
string
Canonical E.164 phone number, with a leading plus sign and four to fifteen digits.
VoiceSequenceReference
object
1 property
1 required
VoiceSequencePlay
object
2 properties
2 required
VoiceSequenceSay
object
3 properties
3 required
VoiceSequenceTone
object
3 properties
3 required
VoiceSequencePause
object
2 properties
2 required
VoiceSequencePromptCommand
VoiceSequenceSlugNext
objectnull
2 properties
2 required
VoiceSequenceWebhookNext
object
2 properties
2 required
VoiceSequenceNext
objectnull
VoiceSequenceGather
object
11 properties
7 required
VoiceSequenceRecordStart
object
3 properties
2 required
VoiceSequenceRecordStop
object
1 property
1 required
VoiceSequenceDial
object
Calls one phone number and connects it to the current call. The next command runs after the destination call ends and the current call's media is restored. If…
3 properties
3 required
VoiceSequenceHangup
object
1 property
1 required
VoiceSequenceCommand
VoiceSequenceInline
object
The sequence to execute first. Subsequent sequence references use the selected published version. The server enforces a total of 16 commands including nested g…
3 properties
3 required
VoiceCallSequenceSource
A slug in the selected published version, or the inline sequence to execute first.
VoiceSequenceVersionID
string
VoiceCreateCallRequest
object
5 properties
3 required
VoiceCallReceipt
object
2 properties
2 required
VoiceCallMediaID
string
VoiceCallMediaState
string
What became of this stored audio. open while capture is still running. available once the bytes are stored. failed when capture did not produce any. purged whe…
VoicePartyEndpointType
string
The technical participant observed on one side of a call. Additional endpoint types may appear in retained observations.
VoiceParty
object
6 properties
VoiceCallMedia
object
10 properties
8 required
VoiceCallRecordingID
string
VoiceCallChannel
string
Which direction of the leg the stream carries: rx for what the platform received, tx for what it sent.
VoiceCallRecording
object
9 properties
8 required
VoiceCallTranscriptID
string
VoiceCallTranscriptState
string
Whether the attempt produced a transcript. failed is an outcome, not evidence that a later attempt cannot succeed.
VoiceCallTranscriptSource
string
What the times in cues are worth: whole for a pass that times nothing, aligned for offline forced alignment, live for a streaming producer.
VoiceCallTranscriptCue
object
4 properties
2 required
VoiceCallTranscript
object
12 properties
9 required
VoiceCallRecordings
object
5 properties
5 required
VoiceRecordingDisposition
string
Whether a signed audio URL plays the recording or saves it. The signature carries this, so it cannot be changed after the URL is minted.
VoiceCallTraceOutcome
string
VoiceCallTraceEndReason
string
VoiceCallTraceCallData
object
5 properties
5 required
VoiceSequenceBody
object
Ordered call commands and the continuation after normal completion. The server enforces a total of 16 commands including nested gather prompts. Gather and hang…
2 properties
2 required
VoiceCallTraceContinuation
objectnull
Null when no continuation was selected; next is null when termination was selected.
1 property
1 required
VoiceCallTraceSequenceData
object
6 properties
6 required
VoiceCallTraceGatherCompletion
string
VoiceCallTraceGatherResult
object
3 properties
3 required
VoiceCallTraceRecordStartResult
object
3 properties
3 required
VoiceDialOutcome
string
Result of a dial command after cleanup leaves the current call usable. - completed: The destination answered, the media connected, and the destination call end…
VoiceCallTraceDialResult
object
3 properties
3 required
VoiceCallTraceCommandData
object
4 properties
2 required
VoiceCallTraceRecordingStopReason
stringnull
VoiceCallTraceRecordingData
object
4 properties
4 required
VoiceCallTraceErrorCode
string
webhookunavailable means the sequence webhook request could not be completed; webhookinvalidresponse means the webhook response failed validation; sequencenotf…
VoiceCallTraceErrorData
object
5 properties
4 required
VoiceCallTraceWebhookData
object
2 properties
2 required
VoiceCallTraceData
VoiceCallTraceSpan
object
7 properties
7 required
VoiceCallTrace
object
5 properties
5 required
VoiceSession
object
10 properties
9 required
VoiceSessionList
VoiceDirectionMeasures
object
One direction's half of the row's calls. Present on every row that carries call-quality statistics, so a bucket, a destination and the period summary all split…
3 properties
3 required
VoiceDirectionSplit
object
Both halves of a row's calls, so one dimension can be read against a fixed inbound/outbound block. direction has exactly these two values, so the two totalcall…
2 properties
2 required
VoiceStatusMeasures
object
How the row's calls ended, as a count per outcome rather than a separate breakdown operation. Every field is a count of the same call legs totalcalls counts, a…
6 properties
6 required
VoiceCallQualityStats
object
Call-quality counts and derived rates for the scope of the containing row (the whole period, a time bucket, or a breakdown dimension). One vocabulary everywher…
17 properties
17 required
VoiceDurationHistogramBucket
object
Answered calls in a fixed billable-duration interval.
3 properties
3 required
VoiceStatsDataAsOf
stringnull
The approximate time through which this response includes completed calls. Active and more recent calls may not be reflected. Use the live call list for curren…
VoiceStatsSummaryPeriod
object
The window the server actually computed against. The summary serves two window grains: calendar days (bounds are YYYY-MM-DD) and hours (bounds are RFC 3339 ins…
3 properties
2 required
VoiceStatsComparisonDelta
object
Change in each headline metric from the preceding period to the requested period. A pctchange is the signed relative change, computed as (current - previous) /…
4 properties
4 required
VoiceStatsComparison
object
The same statistics for the equal-length, inclusive period ending immediately before the requested start, together with the change between the two periods. Eve…
VoiceStatsSummary
object
Aggregate across the full requested period. Includes total and answered call legs, answer-seizure ratio (ASR), average call duration (ACD), and total and billa…
VoiceStatsSeriesPeriod
object
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
4 properties
3 required
VoiceStatsPoint
object
One bucket of the call-statistics series: the same headline metrics as the summary, for a single local day or hour. Buckets with no calls carry zero counts and…
VoiceStatsResponse
object
A bucketed call-statistics series over the requested window. The response contains exactly one point per bucket across the window; buckets with no calls are in…
3 properties
3 required
VoiceStatsPeriod
object
The calendar-day window a breakdown response covers, echoed from the request, plus the freshness boundary the data is current to.
3 properties
2 required
VoiceResponseCodeStatsPoint
object
One row of the per-response-code call breakdown, keyed by the final SIP response code.
3 properties
3 required
VoiceStatsByResponseCodeResponse
object
Per-response-code breakdown for the requested period, ranked by call count descending and capped at the requested limit (default 50, max 200). Every final resp…
4 properties
4 required
VoiceStatsSortMetric
string
Metric used to rank breakdown rows in descending order. totalcalls and answeredcalls place the highest-volume rows first. asr and acdms place the best-performi…
VoiceCountryStatsPoint
object
One row of the per-country call breakdown.
VoiceStatsByCountryResponse
object
Per-country breakdown for the requested period, grouped by destination country, ranked by the sort metric (default totalcalls) descending and capped at the req…
4 properties
4 required
VoiceNumberStatsPoint
object
Call-quality statistics for one own number.
VoiceStatsByNumberResponse
object
Call-quality breakdown by own number for the requested window.
7 properties
7 required
VoiceNumberCountryStatsPoint
object
Call-quality statistics for one own number country.
VoiceStatsByNumberCountryResponse
object
Call-quality breakdown by own number country for the requested window.
7 properties
7 required
VoiceWeekdayStatsPoint
object
Call-quality statistics for one weekday.
VoiceStatsByWeekdayResponse
object
Call-quality breakdown by weekday for the requested window.
4 properties
4 required
VoiceHourOfDayStatsPoint
object
Call-quality statistics for one hour of day.
VoiceStatsByHourOfDayResponse
object
Call-quality breakdown by hour of day for the requested window.
4 properties
4 required
VoiceTrunkStatsPoint
object
One row of the per-trunk call breakdown.
VoiceStatsByTrunkResponse
object
Per-trunk breakdown for the requested period, grouped by SIP trunk, ranked by the sort metric (default totalcalls) descending and capped at the requested limit…
4 properties
4 required
VoiceDestination
object
8 properties
5 required
VoiceDestinationList
object
2 properties
2 required
VoiceDestinationsUpdate
object
1 property
1 required
EsimZoneList
EsimOfferPhoneInclusion
string
How a plan's phone number is provided. always means every eSIM sold from the offer carries a number. onrequest is declared ahead of the plans that attach one p…
EsimOfferPhone
object
Phone service included with the plan. Every eSIM sold from the offer gets its own phone number; each flag states one direction of service on that number. A fal…
5 properties
5 required
EsimOfferData
object
Data allowance of a bundle.
2 properties
1 required
EsimOfferValidityType
string
How the validity period behaves. onetime runs once and expires; recurring renews for a further period each time it lapses.
EsimOfferValidityUnit
string
Unit of the validity period.
EsimOfferValidity
object
How long a package from this offer stays usable. onetime offers run once for the given period after activation; recurring offers renew for a further period eac…
4 properties
3 required
EsimOfferBundlePricing
object
Fixed-allowance terms: a data allowance with a validity period, charged once per provisioned package.
4 properties
4 required
EsimOfferSummary
object
Compact offer row for lists: the full offer minus the embedded zone. Fetch the offer or its zone for the country list.
11 properties
11 required
EsimOfferList
EsimOffer
object
A purchasable offer from the curated catalog: the commercial terms for prepaid data in one coverage zone, priced as your workspace is billed. The coverage itse…
12 properties
12 required
EsimOrderList
EsimOrderCreate
object
Request to purchase a data package. Without esimid, a new eSIM is provisioned carrying the package. With esimid, the package is added to that eSIM: a new cover…
9 properties
1 required
EsimSummary
object
Compact eSIM representation used in lists. Fetch the eSIM by id for the full aggregate with packages, balances, and installation state.
6 properties
6 required
EsimList
EsimUpdate
object
Fields that can be updated on an eSIM.
3 properties
EsimInstallationInstructions
object
Step-by-step install instructions for the traveler, localized by the Accept-Language request header (closest available language, then English).
2 properties
2 required
EsimCredentials
object
Everything needed to install the eSIM on a device, in four forms. Every field is a credential: anyone holding it can install the profile. Treat all of them lik…
11 properties
10 required
EsimDeliveryStatus
string
Outcome of a credential delivery. - pending: accepted; the outcome has not settled. - delivered: the message reached the recipient's provider; terminal. - fail…
EsimCredentialsDelivery
object
One credential delivery to a traveler. Returned when a delivery is accepted and listed on the eSIM's delivery history; the id reappears on the event that settl…
7 properties
7 required
EsimDeliveryList
object
The eSIM's credential deliveries, newest first, most recent 50.
1 property
1 required
EsimPackageList
object
The eSIM's data packages. Bounded: an eSIM holds at most packagelimit concurrent packages, so the list is returned in full.
1 property
1 required
EsimCompatibleOfferList
object
Offers this eSIM can take as a top-up right now, given its mobile network, current packages, and packagelimit. A point-in-time answer; re-fetch rather than cac…
2 properties
2 required
EsimUsageRecord
object
One day of data usage for an eSIM in one country.
5 properties
5 required
EsimUsageRecordList
EsimOverviewEsimStatusCount
object
Number of the workspace's eSIMs in one lifecycle status.
2 properties
2 required
EsimOverviewEsims
object
eSIM counts for the workspace, split by lifecycle status.
2 properties
2 required
EsimOverviewDataBalance
object
The combined data balance across the workspace's live packages - the same packages whose balances the per-eSIM reads serve. Zones can overlap in a country, so…
4 properties
4 required
EsimOverviewPackages
object
Package counts for the workspace's live data packages.
3 properties
3 required
EsimOverviewOrderStatusCount
object
Number of the workspace's orders in one status.
2 properties
2 required
EsimOverviewOrders
object
Order counts for the workspace, split by status.
2 properties
2 required
EsimOverviewSpendLine
object
Completed-order spend in one currency: exact sums of the orders' net prices as quoted at purchase, before any tax billing adds - never converted to another cur…
5 properties
5 required
EsimOverview
object
Fleet-wide eSIM statistics for the workspace, computed at read time from the same eSIMs, packages, and orders the resource lists return.
5 properties
5 required
VoiceBuiltinSequence
object
2 properties
2 required
VoiceBuiltinSequenceList
object
1 property
1 required
VoiceSequenceVersionStatus
string
- draft: Editable version selected for new calls from matching tester callers. - active: Published version selected for new calls that do not select the draft.…
VoiceSequenceVersionNote
string
Version note, limited by the service to 1024 UTF-8 bytes. maxLength also bounds characters; multibyte text can reach the byte limit sooner. Exceeding the byte…
VoiceSequenceVersion
object
6 properties
6 required
VoiceSequenceVersionList
VoiceSequenceVersionCreate
object
2 properties
VoiceSequenceVersionPatch
object
2 properties
VoiceSequenceChangeKind
string
Difference from the active version captured for this page.
VoiceSequenceChangeSummary
object
2 properties
2 required
VoiceSequenceDiff
Changed-slug summaries against the active version captured for this page. A null activeversionid means the baseline is empty. Fetch each sequence body separate…
VoiceSequenceValidationDiagnosticKind
string
Diagnostic category. Open enum: additional categories may be introduced; display their path and message without rejecting an unfamiliar kind.
VoiceSequenceValidationSeverity
string
Errors block publication. Warnings describe consequences that do not block publication.
VoiceSequenceValidationDiagnostic
object
5 properties
4 required
VoiceSequenceValidation
Advisory inspection of every saved body and current external references. Each page is a new inspection unless its idempotency key replays an earlier result. Se…
VoiceSequenceSummary
object
3 properties
2 required
VoiceSequenceList
VoiceSequenceCreate
object
Ordered call commands and the continuation after normal completion. The server enforces a total of 16 commands including nested gather prompts. Gather and hang…
4 properties
3 required
VoiceSequence
object
Ordered call commands and the continuation after normal completion. The server enforces a total of 16 commands including nested gather prompts. Gather and hang…
5 properties
4 required
VoiceSequencePatch
object
Ordered call commands and the continuation after normal completion. The server enforces a total of 16 commands including nested gather prompts. Gather and hang…
3 properties
2 required
VoiceSequenceDocument
object
6 properties
4 required
VoiceSequenceDocumentInput
object
4 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Email#SMS#WhatsApp#Voice#Messaging#Verification#Lookup#Contacts#Webhook#Real-Time
Where this information came from
This is an independent, third-party profile of Bird API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.