# Bird API Docs

## API | Bird CRM

- [Welcome to the Bird API Docs](https://docs.bird.com/api/welcome-to-the-bird-api-docs.md): The Bird platform has a large suite of APIs you can use to integrate with to buy numbers, manage contacts and send messages to your customers.
- [API Access](https://docs.bird.com/api/api-access.md)
- [Access Policies](https://docs.bird.com/api/api-access/access-policies.md)
- [Access Roles](https://docs.bird.com/api/api-access/access-roles.md)
- [API Authorization](https://docs.bird.com/api/api-access/api-authorization.md)
- [Common API usage](https://docs.bird.com/api/api-access/common-api-usage.md)
- [Conversations API](https://docs.bird.com/api/conversations-api.md)
- [API reference](https://docs.bird.com/api/conversations-api/api-reference.md): To learn more about the Conversations API, please refer to the API References linked below.
- [Channel configuration](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration.md)
- [Get conversations configuration](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration/get-conversations-configuration.md)
- [Update conversations configuration](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration/update-conversations-configuration.md)
- [Conversations messaging](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging.md)
- [Create conversation message](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/create-conversation-message.md)
- [List conversation messages](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/list-conversation-messages.md)
- [Get conversation message](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/get-conversation-message.md)
- [Update conversation message](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/update-conversation-message.md)
- [Delete conversation message](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/delete-conversation-message.md)
- [Create pre-signed upload](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/create-pre-signed-upload.md)
- [Conversations management](https://docs.bird.com/api/conversations-api/api-reference/conversations-management.md)
- [Create conversation](https://docs.bird.com/api/conversations-api/api-reference/conversations-management/create-conversation.md)
- [List conversations](https://docs.bird.com/api/conversations-api/api-reference/conversations-management/list-conversations.md)
- [Get conversation](https://docs.bird.com/api/conversations-api/api-reference/conversations-management/get-conversation.md)
- [Update conversation](https://docs.bird.com/api/conversations-api/api-reference/conversations-management/update-conversation.md)
- [Delete conversation](https://docs.bird.com/api/conversations-api/api-reference/conversations-management/delete-conversation.md)
- [Conversation Participants](https://docs.bird.com/api/conversations-api/api-reference/conversation-participants.md)
- [Add participant to conversation](https://docs.bird.com/api/conversations-api/api-reference/conversation-participants/add-participant-to-conversation.md)
- [List participants](https://docs.bird.com/api/conversations-api/api-reference/conversation-participants/list-participants.md)
- [Get participant by ID](https://docs.bird.com/api/conversations-api/api-reference/conversation-participants/get-participant-by-id.md)
- [Get participant by identifier key and value](https://docs.bird.com/api/conversations-api/api-reference/conversation-participants/get-participant-by-identifier-key-and-value.md)
- [Update participant by ID](https://docs.bird.com/api/conversations-api/api-reference/conversation-participants/update-participant-by-id.md)
- [Update participant by v key and value](https://docs.bird.com/api/conversations-api/api-reference/conversation-participants/update-participant-by-v-key-and-value.md)
- [Delete participant](https://docs.bird.com/api/conversations-api/api-reference/conversation-participants/delete-participant.md)
- [List participant conversations by ID](https://docs.bird.com/api/conversations-api/api-reference/conversation-participants/list-participant-conversations-by-id.md)
- [List participant conversations by identifier key and value](https://docs.bird.com/api/conversations-api/api-reference/conversation-participants/list-participant-conversations-by-identifier-key-and-value.md)
- [Workspace settings](https://docs.bird.com/api/conversations-api/api-reference/workspace-settings.md)
- [Get antispam setting](https://docs.bird.com/api/conversations-api/api-reference/workspace-settings/get-antispam-setting.md)
- [Update antispam setting](https://docs.bird.com/api/conversations-api/api-reference/workspace-settings/update-antispam-setting.md)
- [Create allow/block rule](https://docs.bird.com/api/conversations-api/api-reference/workspace-settings/create-allow-block-rule.md)
- [Get allow/block rule](https://docs.bird.com/api/conversations-api/api-reference/workspace-settings/get-allow-block-rule.md)
- [List allow/block rules](https://docs.bird.com/api/conversations-api/api-reference/workspace-settings/list-allow-block-rules.md)
- [Update allow/block rule](https://docs.bird.com/api/conversations-api/api-reference/workspace-settings/update-allow-block-rule.md)
- [Delete allow/block rule](https://docs.bird.com/api/conversations-api/api-reference/workspace-settings/delete-allow-block-rule.md)
- [Add allow/block rules in bulk](https://docs.bird.com/api/conversations-api/api-reference/workspace-settings/add-allow-block-rules-in-bulk.md)
- [Get allow/block bulk upload status](https://docs.bird.com/api/conversations-api/api-reference/workspace-settings/get-allow-block-bulk-upload-status.md)
- [Events](https://docs.bird.com/api/conversations-api/api-reference/events.md)
- [Collaborations API](https://docs.bird.com/api/collaborations-api.md)
- [API reference](https://docs.bird.com/api/collaborations-api/api-reference.md)
- [Agent Management](https://docs.bird.com/api/collaborations-api/api-reference/agent-management.md)
- [Team Management](https://docs.bird.com/api/collaborations-api/api-reference/team-management.md)
- [Feeds](https://docs.bird.com/api/collaborations-api/api-reference/feeds.md)
- [Feed item activity](https://docs.bird.com/api/collaborations-api/api-reference/feed-item-activity.md): Feed item activity records any interaction with the feed item, e.g. the status of the feed item changed, or an agent or team was assigned. Additionally, comments are also recorded as activity.
- [Tags](https://docs.bird.com/api/collaborations-api/api-reference/tags.md)
- [Automation Rules](https://docs.bird.com/api/collaborations-api/api-reference/automation-rules.md)
- [Business Hours](https://docs.bird.com/api/collaborations-api/api-reference/business-hours.md)
- [Capacity Rules](https://docs.bird.com/api/collaborations-api/api-reference/capacity-rules.md)
- [Routing Queues](https://docs.bird.com/api/collaborations-api/api-reference/routing-queues.md)
- [Skills](https://docs.bird.com/api/collaborations-api/api-reference/skills.md)
- [SLA Policies](https://docs.bird.com/api/collaborations-api/api-reference/sla-policies.md)
- [Macros](https://docs.bird.com/api/collaborations-api/api-reference/macros.md)
- [Sender Profiles](https://docs.bird.com/api/collaborations-api/api-reference/sender-profiles.md)
- [Ticket fields](https://docs.bird.com/api/collaborations-api/api-reference/ticket-fields.md): Ticket fields allow to add
- [Channels API](https://docs.bird.com/api/channels-api.md): Channels API overview
- [Supported channels](https://docs.bird.com/api/channels-api/supported-channels.md)
- [Programmable WhatsApp](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp.md): How to integrate with our Channels API for WhatsApp Messaging
- [Sending WhatsApp messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/sending-whatsapp-messages.md)
- [Customer service window](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/customer-service-window.md)
- [Receiving messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/receiving-messages.md)
- [Message interactions](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/message-interactions.md)
- [WhatsApp ISV integration](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/whatsapp-isv-integration.md)
- [Setting up your customer workspaces](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/whatsapp-isv-integration/setting-up-your-customer-workspaces.md)
- [API Access](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/whatsapp-isv-integration/setting-up-your-customer-workspaces/api-access.md)
- [Associating your Facebook solution ID and business ID with your Bird CRM Organization](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/whatsapp-isv-integration/setting-up-your-customer-workspaces/associating-your-facebook-solution-id-and-business-id-with-your-bird-crm-organization.md)
- [Creating a workspace for your customer](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/whatsapp-isv-integration/setting-up-your-customer-workspaces/creating-a-workspace-for-your-customer.md)
- [Buying a number through Bird](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/whatsapp-isv-integration/setting-up-your-customer-workspaces/buying-a-number-through-bird.md)
- [Subscribing to channel created webhooks](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/whatsapp-isv-integration/setting-up-your-customer-workspaces/subscribing-to-channel-created-webhooks.md)
- [WhatsApp channel onboarding](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/whatsapp-isv-integration/whatsapp-channel-onboarding.md)
- [Setting up the WhatsApp Embedded flow](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/whatsapp-isv-integration/whatsapp-channel-onboarding/setting-up-the-whatsapp-embedded-flow.md)
- [Install WhatsApp phone number in Bird CRM](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/whatsapp-isv-integration/whatsapp-channel-onboarding/install-whatsapp-phone-number-in-bird-crm.md)
- [Subscribe to channel webhooks](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/whatsapp-isv-integration/whatsapp-channel-onboarding/subscribe-to-channel-webhooks.md)
- [Monitoring WhatsApp channel health](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/whatsapp-isv-integration/whatsapp-channel-onboarding/monitoring-whatsapp-channel-health.md)
- [Business-Scoped User IDs](https://docs.bird.com/api/channels-api/supported-channels/programmable-whatsapp/business-scoped-user-ids.md): WhatsApp Business-Scoped User IDs (BSUIDs) — API Examples
- [Programmable SMS](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms.md): How to integrate with our Channels API for SMS/MMS Messaging
- [Installing an SMS channel](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/installing-an-sms-channel.md)
- [US 10DLC API Installation](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/installing-an-sms-channel/us-10dlc-api-installation.md): A quick start to install a US 10 DLC number
- [Toll-Free Numbers Verification API](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/installing-an-sms-channel/toll-free-numbers-verification-api.md)
- [SMS Use Cases](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/installing-an-sms-channel/sms-use-cases.md): A quick start to Use Case management
- [Sending SMS messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/sending-sms-messages.md)
- [Smart Encoding](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/sending-sms-messages/smart-encoding.md): Smart Encoding is an optional feature that automatically transliterates Unicode characters to their GSM-7 equivalents, potentially reducing the number of message segments required to send your SMS.
- [Receiving messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/receiving-messages.md)
- [Message interactions](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/message-interactions.md)
- [Twilio Exit API](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/twilio-exit-api.md)
- [Using Twilio PHP SDK](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/twilio-exit-api/using-twilio-php-sdk.md)
- [Using Twilio Go SDK](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/twilio-exit-api/using-twilio-go-sdk.md)
- [Using Twilio Ruby SDK](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/twilio-exit-api/using-twilio-ruby-sdk.md)
- [Sinch Exit API](https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/sinch-exit-api.md)
- [Programmable RCS](https://docs.bird.com/api/channels-api/supported-channels/programmable-rcs.md): How to integrate with our Channels API for Google RCS Messaging
- [Sending messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-rcs/sending-messages.md)
- [Receiving messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-rcs/receiving-messages.md)
- [Message interactions](https://docs.bird.com/api/channels-api/supported-channels/programmable-rcs/message-interactions.md)
- [Programmable Email](https://docs.bird.com/api/channels-api/supported-channels/programmable-email.md): How to integrate with Channels API for Email messaging
- [Sending Emails](https://docs.bird.com/api/channels-api/supported-channels/programmable-email/sending-emails.md)
- [Receiving messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-email/receiving-messages.md)
- [Message status](https://docs.bird.com/api/channels-api/supported-channels/programmable-email/message-status.md)
- [Message interactions](https://docs.bird.com/api/channels-api/supported-channels/programmable-email/message-interactions.md)
- [Programmable Line](https://docs.bird.com/api/channels-api/supported-channels/programmable-line.md): How to integrate with our Channels API for Line Messaging
- [Sending messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-line/sending-messages.md)
- [Receiving messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-line/receiving-messages.md)
- [Message interactions](https://docs.bird.com/api/channels-api/supported-channels/programmable-line/message-interactions.md)
- [Programmable Telegram](https://docs.bird.com/api/channels-api/supported-channels/programmable-telegram.md)
- [Sending messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-telegram/sending-messages.md)
- [Receiving messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-telegram/receiving-messages.md)
- [Message interactions](https://docs.bird.com/api/channels-api/supported-channels/programmable-telegram/message-interactions.md)
- [Programmable Apple Messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-apple-messages.md): How to integrate with our Channels API for Apple Messages
- [Sending messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-apple-messages/sending-messages.md)
- [Receiving messages](https://docs.bird.com/api/channels-api/supported-channels/programmable-apple-messages/receiving-messages.md)
- [Message interactions](https://docs.bird.com/api/channels-api/supported-channels/programmable-apple-messages/message-interactions.md)
- [Programmable Push Notifications](https://docs.bird.com/api/channels-api/supported-channels/programmable-push-notifications.md)
- [Message types](https://docs.bird.com/api/channels-api/message-types.md)
- [Text](https://docs.bird.com/api/channels-api/message-types/text.md): Text message examples shown for each supported platform
- [Images](https://docs.bird.com/api/channels-api/message-types/images.md): Image message examples shown for each supported platform
- [Files](https://docs.bird.com/api/channels-api/message-types/files.md): File message examples shown for each supported platform
- [List](https://docs.bird.com/api/channels-api/message-types/list.md): List message examples shown for each supported platform
- [Carousel](https://docs.bird.com/api/channels-api/message-types/carousel.md)
- [Template](https://docs.bird.com/api/channels-api/message-types/template.md): Sending template messages
- [Message status and interactions](https://docs.bird.com/api/channels-api/message-status-and-interactions.md)
- [Message Failure Codes](https://docs.bird.com/api/channels-api/message-status-and-interactions/message-failure-codes.md)
- [Message Failure Sources](https://docs.bird.com/api/channels-api/message-status-and-interactions/message-failure-sources.md)
- [SMS Platform Extended Error Codes](https://docs.bird.com/api/channels-api/message-status-and-interactions/message-failure-sources/sms-platform-extended-error-codes.md)
- [Send batch messages](https://docs.bird.com/api/channels-api/send-batch-messages.md)
- [API reference](https://docs.bird.com/api/channels-api/api-reference.md)
- [Channel Groups](https://docs.bird.com/api/channels-api/api-reference/channel-groups.md)
- [Messaging](https://docs.bird.com/api/channels-api/api-reference/messaging.md)
- [Channels management](https://docs.bird.com/api/channels-api/api-reference/channels-management.md)
- [Channel connectors](https://docs.bird.com/api/channels-api/api-reference/channel-connectors.md)
- [Navigators](https://docs.bird.com/api/channels-api/api-reference/navigators.md): Navigators allow you to send a message via the best of multiple channels.
- [Compliance Keywords Messages](https://docs.bird.com/api/channels-api/api-reference/compliance-keywords-messages.md)
- [Conversions Sharing](https://docs.bird.com/api/channels-api/api-reference/conversions-sharing.md): Sharing conversion events with Bird help us improve the quality and reduce the cost of of Bird services
- [Events](https://docs.bird.com/api/channels-api/api-reference/events.md)
- [Rate Limit](https://docs.bird.com/api/channels-api/rate-limit.md)
- [Voice API](https://docs.bird.com/api/voice-api.md): The Voice API covers Voice Calls API, Recordings API and Transcriptions API.
- [Installing a Voice channel](https://docs.bird.com/api/voice-api/installing-a-voice-channel.md)
- [Voice Calls API](https://docs.bird.com/api/voice-api/voice-calls-api.md)
- [Initiate an outbound call](https://docs.bird.com/api/voice-api/voice-calls-api/initiate-an-outbound-call.md)
- [List calls from a channel](https://docs.bird.com/api/voice-api/voice-calls-api/list-calls-from-a-channel.md)
- [Get a call](https://docs.bird.com/api/voice-api/voice-calls-api/get-a-call.md)
- [Update a call](https://docs.bird.com/api/voice-api/voice-calls-api/update-a-call.md)
- [Answer a call](https://docs.bird.com/api/voice-api/voice-calls-api/answer-a-call.md)
- [Ring a call](https://docs.bird.com/api/voice-api/voice-calls-api/ring-a-call.md)
- [Hangup a call](https://docs.bird.com/api/voice-api/voice-calls-api/hangup-a-call.md)
- [Play a message in a call](https://docs.bird.com/api/voice-api/voice-calls-api/play-a-message-in-a-call.md)
- [Say Text-To-Speech (TTS)](https://docs.bird.com/api/voice-api/voice-calls-api/say-text-to-speech-tts.md)
- [Gather DTMF from a call](https://docs.bird.com/api/voice-api/voice-calls-api/gather-dtmf-from-a-call.md)
- [Forward a call](https://docs.bird.com/api/voice-api/voice-calls-api/forward-a-call.md)
- [Record a Call](https://docs.bird.com/api/voice-api/voice-calls-api/record-a-call.md)
- [Record a call session](https://docs.bird.com/api/voice-api/voice-calls-api/record-a-call-session.md)
- [Update a call recording](https://docs.bird.com/api/voice-api/voice-calls-api/update-a-call-recording.md)
- [List call recordings of a call](https://docs.bird.com/api/voice-api/voice-calls-api/list-call-recordings-of-a-call.md)
- [Get a call recording](https://docs.bird.com/api/voice-api/voice-calls-api/get-a-call-recording.md)
- [Get a call insights](https://docs.bird.com/api/voice-api/voice-calls-api/get-a-call-insights.md)
- [Get calls log](https://docs.bird.com/api/voice-api/voice-calls-api/get-calls-log.md)
- [Recordings API](https://docs.bird.com/api/voice-api/recordings-api.md)
- [List Recordings](https://docs.bird.com/api/voice-api/recordings-api/list-recordings.md)
- [Get a Recording](https://docs.bird.com/api/voice-api/recordings-api/get-a-recording.md)
- [Delete a Recording](https://docs.bird.com/api/voice-api/recordings-api/delete-a-recording.md)
- [List recording storage metrics](https://docs.bird.com/api/voice-api/recordings-api/list-recording-storage-metrics.md)
- [Transcriptions API](https://docs.bird.com/api/voice-api/transcriptions-api.md)
- [Initiate a Transcription](https://docs.bird.com/api/voice-api/transcriptions-api/initiate-a-transcription.md)
- [List Transcriptions](https://docs.bird.com/api/voice-api/transcriptions-api/list-transcriptions.md)
- [Get a Transcription](https://docs.bird.com/api/voice-api/transcriptions-api/get-a-transcription.md)
- [Delete a Transcription](https://docs.bird.com/api/voice-api/transcriptions-api/delete-a-transcription.md)
- [Voice webhooks](https://docs.bird.com/api/voice-api/voice-webhooks.md)
- [Flash Calling API](https://docs.bird.com/api/voice-api/flash-calling-api.md): The Flash Call API is used to initiate a flash call within a specific workspace and channel.
- [Verify API](https://docs.bird.com/api/verify-api.md)
- [Verify API: Quick Start](https://docs.bird.com/api/verify-api/verify-api-quick-start.md)
- [Contacts API](https://docs.bird.com/api/contacts-api.md): The Bird Contacts API allows you to manage contact data, including creating and organizing contact records, defining identifiers, attributes, suppressions, and lists for an efficient data management
- [Tracking Contact Events](https://docs.bird.com/api/contacts-api/tracking-contact-events.md)
- [API Reference](https://docs.bird.com/api/contacts-api/tracking-contact-events/api-reference.md): To learn more about Tracking Contact Events, please refer to the API Reference linked below.
- [Get configuration](https://docs.bird.com/api/contacts-api/tracking-contact-events/api-reference/get-configuration.md)
- [Track events](https://docs.bird.com/api/contacts-api/tracking-contact-events/api-reference/track-events.md)
- [Tracking contact events](https://docs.bird.com/api/contacts-api/tracking-contact-events-1.md)
- [API reference](https://docs.bird.com/api/contacts-api/api-reference.md): To learn more about Contacts API, please refer to the API Reference linked below.
- [Manage workspace contacts](https://docs.bird.com/api/contacts-api/api-reference/manage-workspace-contacts.md): The following endpoints allow for creating contacts and managing their life cycle.
- [Create a contact](https://docs.bird.com/api/contacts-api/api-reference/manage-workspace-contacts/create-a-contact.md)
- [Get a contact](https://docs.bird.com/api/contacts-api/api-reference/manage-workspace-contacts/get-a-contact.md)
- [List contacts](https://docs.bird.com/api/contacts-api/api-reference/manage-workspace-contacts/list-contacts.md)
- [Search contact by identifier](https://docs.bird.com/api/contacts-api/api-reference/manage-workspace-contacts/search-contact-by-identifier.md)
- [Update a contact](https://docs.bird.com/api/contacts-api/api-reference/manage-workspace-contacts/update-a-contact.md)
- [Create or update a contact by identifier](https://docs.bird.com/api/contacts-api/api-reference/manage-workspace-contacts/create-or-update-a-contact-by-identifier.md)
- [Delete a contact](https://docs.bird.com/api/contacts-api/api-reference/manage-workspace-contacts/delete-a-contact.md)
- [Manage contact identifiers](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-identifiers.md): The following endpoints allow for managing the identifiers for a single contact.
- [Create contact identifier](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-identifiers/create-contact-identifier.md)
- [List contact identifiers](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-identifiers/list-contact-identifiers.md)
- [Delete contact identifier](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-identifiers/delete-contact-identifier.md)
- [Manage contact attribute definition](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-attribute-definition.md): The following endpoints allow for managing the custom attribute schema for your contacts.
- [Create attribute definition](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-attribute-definition/create-attribute-definition.md)
- [Get attribute definition](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-attribute-definition/get-attribute-definition.md)
- [List attribute definitions](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-attribute-definition/list-attribute-definitions.md)
- [Manage contact lists](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-lists.md): The following endpoints allow for creating contact lists and managing their life cycle.
- [Create a list](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-lists/create-a-list.md)
- [Get a list](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-lists/get-a-list.md)
- [List lists](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-lists/list-lists.md)
- [Update a list](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-lists/update-a-list.md)
- [Delete a list](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-lists/delete-a-list.md)
- [Add contacts to a list](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-lists/add-contacts-to-a-list.md)
- [Get contact list memberships](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-lists/get-contact-list-memberships.md)
- [List contacts in a list](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-lists/list-contacts-in-a-list.md)
- [Remove contacts from a list](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-lists/remove-contacts-from-a-list.md)
- [Manage contact suppressions](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-suppressions.md): The following endpoints allow for managing suppressions for a single identifier value.
- [Upsert a workspace-platform-level suppression](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-suppressions/upsert-a-workspace-platform-level-suppression.md)
- [Get a suppression](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-suppressions/get-a-suppression.md)
- [List workspace-platform-level suppressions](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-suppressions/list-workspace-platform-level-suppressions.md)
- [Manage custom objects](https://docs.bird.com/api/contacts-api/api-reference/manage-custom-objects.md)
- [Numbers API](https://docs.bird.com/api/numbers-api.md)
- [API reference](https://docs.bird.com/api/numbers-api/api-reference.md)
- [Search Available Numbers](https://docs.bird.com/api/numbers-api/api-reference/search-available-numbers.md)
- [Buy a Number](https://docs.bird.com/api/numbers-api/api-reference/buy-a-number.md)
- [List your Numbers](https://docs.bird.com/api/numbers-api/api-reference/list-your-numbers.md)
- [Number Lookup](https://docs.bird.com/api/numbers-api/api-reference/number-lookup.md)
- [Network/Country information for a phone number](https://docs.bird.com/api/numbers-api/api-reference/number-lookup/network-country-information-for-a-phone-number.md)
- [Get Long Code Number Details](https://docs.bird.com/api/numbers-api/api-reference/get-long-code-number-details.md)
- [Manage Endpoint Subscriptions](https://docs.bird.com/api/numbers-api/api-reference/manage-endpoint-subscriptions.md)
- [Cancel Number Subscription](https://docs.bird.com/api/numbers-api/api-reference/manage-endpoint-subscriptions/cancel-number-subscription.md)
- [Manage Endpoint Compliance Requirements](https://docs.bird.com/api/numbers-api/api-reference/manage-endpoint-compliance-requirements.md)
- [List Workspace compliance Requirements](https://docs.bird.com/api/numbers-api/api-reference/manage-endpoint-compliance-requirements/list-workspace-compliance-requirements.md)
- [Get Workspace Compliance Requirements](https://docs.bird.com/api/numbers-api/api-reference/manage-endpoint-compliance-requirements/get-workspace-compliance-requirements.md)
- [Update Workspace Compliance Requirements](https://docs.bird.com/api/numbers-api/api-reference/manage-endpoint-compliance-requirements/update-workspace-compliance-requirements.md)
- [10DLC Compliance](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance.md): Creating Brands and Campaigns registrations with The Campaign Registry
- [Brands - Organization](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-organization.md): Create and manage brands for your organization
- [Create a brand](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-organization/create-a-brand.md)
- [List all brands](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-organization/list-all-brands.md)
- [Get a brand](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-organization/get-a-brand.md)
- [Update a brand](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-organization/update-a-brand.md)
- [Delete a brand](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-organization/delete-a-brand.md)
- [Create a brand vetting](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-organization/create-a-brand-vetting.md)
- [Brands - workspace](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-workspace.md): Create and manage Brands for your workspace
- [Create a brand](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-workspace/create-a-brand.md)
- [List all brands](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-workspace/list-all-brands.md)
- [Get a brand](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-workspace/get-a-brand.md)
- [Update a brand](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-workspace/update-a-brand.md)
- [Delete a brand](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-workspace/delete-a-brand.md)
- [Create a brand vetting](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-workspace/create-a-brand-vetting.md)
- [List brand vettings](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-workspace/list-brand-vettings.md)
- [Campaigns](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/campaigns.md)
- [Optional: acting as Reseller](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/campaigns/optional-acting-as-reseller.md)
- [Create a campaign](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/campaigns/create-a-campaign.md)
- [List all campaigns](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/campaigns/list-all-campaigns.md)
- [Get a campaign](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/campaigns/get-a-campaign.md)
- [Update a campaign](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/campaigns/update-a-campaign.md)
- [Delete a campaign](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/campaigns/delete-a-campaign.md)
- [TCR Enums](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/tcr-enums.md)
- [Events](https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/events.md)
- [Toll-Free Numbers Verification API](https://docs.bird.com/api/numbers-api/api-reference/toll-free-numbers-verification-api.md)
- [Events](https://docs.bird.com/api/numbers-api/api-reference/toll-free-numbers-verification-api/events.md)
- [Long Code Numbers](https://docs.bird.com/api/numbers-api/api-reference/long-code-numbers.md)
- [Short Code Numbers](https://docs.bird.com/api/numbers-api/api-reference/short-code-numbers.md)
- [Alphanumeric Senders](https://docs.bird.com/api/numbers-api/api-reference/alphanumeric-senders.md)
- [Events](https://docs.bird.com/api/numbers-api/api-reference/events.md)
- [Destination management API](https://docs.bird.com/api/numbers-api/api-reference/destination-management-api.md): Set the outbound SMS destination policy for a workspace.
- [Know-Your-Customer (KYC) API](https://docs.bird.com/api/know-your-customer-kyc-api.md)
- [List KYC forms](https://docs.bird.com/api/know-your-customer-kyc-api/list-kyc-forms.md)
- [Get KYC form](https://docs.bird.com/api/know-your-customer-kyc-api/get-kyc-form.md)
- [Create KYC form entry](https://docs.bird.com/api/know-your-customer-kyc-api/create-kyc-form-entry.md)
- [Update KYC form entry](https://docs.bird.com/api/know-your-customer-kyc-api/update-kyc-form-entry.md)
- [List KYC form entries](https://docs.bird.com/api/know-your-customer-kyc-api/list-kyc-form-entries.md)
- [Get a KYC form entry details](https://docs.bird.com/api/know-your-customer-kyc-api/get-a-kyc-form-entry-details.md)
- [Local Brand Identification](https://docs.bird.com/api/know-your-customer-kyc-api/local-brand-identification.md)
- [Reporting API](https://docs.bird.com/api/reporting-api.md): Reporting API Overview
- [API reference](https://docs.bird.com/api/reporting-api/api-reference.md)
- [Channel Metrics](https://docs.bird.com/api/reporting-api/api-reference/channel-metrics.md): Querying Message Metrics
- [Flow Run Metrics](https://docs.bird.com/api/reporting-api/api-reference/flow-run-metrics.md): Query Metrics Related to Your Flow Runs
- [Wallet Metrics](https://docs.bird.com/api/reporting-api/api-reference/wallet-metrics.md): Query Metrics Related to Wallet and Product Usage
- [Campaign Metrics](https://docs.bird.com/api/reporting-api/api-reference/campaign-metrics.md): Query Metrics Related to Campaigns
- [Journey Metrics](https://docs.bird.com/api/reporting-api/api-reference/journey-metrics.md)
- [Message Metrics](https://docs.bird.com/api/reporting-api/api-reference/message-metrics.md): Query Metrics Related to Messages
- [Reports](https://docs.bird.com/api/reporting-api/api-reference/reports.md): Usage reports
- [Accounts API](https://docs.bird.com/api/accounts-api.md)
- [API reference](https://docs.bird.com/api/accounts-api/api-reference.md)
- [Current user](https://docs.bird.com/api/accounts-api/api-reference/current-user.md): Make updates to the user to which the login token was issued.
- [Change password](https://docs.bird.com/api/accounts-api/api-reference/current-user/change-password.md)
- [Presigned upload](https://docs.bird.com/api/accounts-api/api-reference/current-user/presigned-upload.md)
- [Memberships](https://docs.bird.com/api/accounts-api/api-reference/current-user/memberships.md)
- [Sessions](https://docs.bird.com/api/accounts-api/api-reference/current-user/sessions.md)
- [Configurations](https://docs.bird.com/api/accounts-api/api-reference/current-user/configurations.md)
- [Groups](https://docs.bird.com/api/accounts-api/api-reference/current-user/configurations/groups.md)
- [Keys](https://docs.bird.com/api/accounts-api/api-reference/current-user/configurations/groups/keys.md)
- [IAM policies](https://docs.bird.com/api/accounts-api/api-reference/iam-policies.md)
- [Organizations](https://docs.bird.com/api/accounts-api/api-reference/organizations.md)
- [Upload media](https://docs.bird.com/api/accounts-api/api-reference/organizations/upload-media.md)
- [Profile](https://docs.bird.com/api/accounts-api/api-reference/organizations/profile.md)
- [Workspaces](https://docs.bird.com/api/accounts-api/api-reference/organizations/workspaces.md)
- [Users](https://docs.bird.com/api/accounts-api/api-reference/organizations/users.md)
- [Access keys](https://docs.bird.com/api/accounts-api/api-reference/organizations/access-keys.md)
- [Organization roles](https://docs.bird.com/api/accounts-api/api-reference/organizations/organization-roles.md): Roles group one or more organization policies, and can be assigned to organization users and access keys.
- [Organization policies](https://docs.bird.com/api/accounts-api/api-reference/organizations/organization-policies.md): Allows you to define fine-grained access policies on your organization
- [Teams](https://docs.bird.com/api/accounts-api/api-reference/organizations/teams.md)
- [Members](https://docs.bird.com/api/accounts-api/api-reference/organizations/teams/members.md)
- [Approvals](https://docs.bird.com/api/accounts-api/api-reference/organizations/approvals.md)
- [Runs](https://docs.bird.com/api/accounts-api/api-reference/organizations/approvals/runs.md)
- [Reviews](https://docs.bird.com/api/accounts-api/api-reference/organizations/approvals/runs/reviews.md)
- [Configurations](https://docs.bird.com/api/accounts-api/api-reference/organizations/configurations.md)
- [Groups](https://docs.bird.com/api/accounts-api/api-reference/organizations/configurations/groups.md)
- [Keys](https://docs.bird.com/api/accounts-api/api-reference/organizations/configurations/groups/keys.md)
- [Region groups](https://docs.bird.com/api/accounts-api/api-reference/region-groups.md)
- [Touchpoints API](https://docs.bird.com/api/touchpoints-api.md): Touchpoints API overview
- [Supported Projects](https://docs.bird.com/api/touchpoints-api/supported-projects.md)
- [Whatsapp Approved Message Templates](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates.md)
- [Creating WhatsApp Message templates](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/creating-whatsapp-message-templates.md): Step-by-step process of creating a Whatsapp Message Template using the Touchpoints API.
- [WhatsApp Template Blocks Reference](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/creating-whatsapp-message-templates/whatsapp-template-blocks-reference.md)
- [Text templates](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/creating-whatsapp-message-templates/text-templates.md): A text template can contain a header, body, footer and buttons.
- [Image templates](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/creating-whatsapp-message-templates/image-templates.md)
- [File & Video Templates](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/creating-whatsapp-message-templates/file-and-video-templates.md)
- [Carousel Templates](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/creating-whatsapp-message-templates/carousel-templates.md)
- [Coupon Templates](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/creating-whatsapp-message-templates/coupon-templates.md)
- [Limited Time Offer Templates](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/creating-whatsapp-message-templates/limited-time-offer-templates.md)
- [Flow Templates](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/creating-whatsapp-message-templates/flow-templates.md)
- [Catalog Templates](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/creating-whatsapp-message-templates/catalog-templates.md)
- [Multi-Product Templates](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/creating-whatsapp-message-templates/multi-product-templates.md)
- [Authentication Templates](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/creating-whatsapp-message-templates/authentication-templates.md)
- [WhatsApp Template Webhooks](https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/whatsapp-template-webhooks.md)
- [Creating HTML Email Templates](https://docs.bird.com/api/touchpoints-api/supported-projects/creating-html-email-templates.md)
- [API reference](https://docs.bird.com/api/touchpoints-api/api-reference.md)
- [Projects](https://docs.bird.com/api/touchpoints-api/api-reference/projects.md)
- [Message Templates](https://docs.bird.com/api/touchpoints-api/api-reference/message-templates.md)
- [Template Webhooks](https://docs.bird.com/api/touchpoints-api/api-reference/message-templates/template-webhooks.md)
- [Email Templates](https://docs.bird.com/api/touchpoints-api/api-reference/email-templates.md)
- [Notifications API](https://docs.bird.com/api/notifications-api.md): Bird's Notification API offers real-time event monitoring with customizable webhooks, detailed logs and reliable retries, ensuring seamless integration for tracking messages, payments, and compliance
- [API Reference](https://docs.bird.com/api/notifications-api/api-reference.md): To learn more about Notifications API, please refer to the API Reference linked below.
- [Webhook subscriptions](https://docs.bird.com/api/notifications-api/api-reference/webhook-subscriptions.md)
- [Create a webhook subscription](https://docs.bird.com/api/notifications-api/api-reference/webhook-subscriptions/create-a-webhook-subscription.md)
- [List available webhook events](https://docs.bird.com/api/notifications-api/api-reference/webhook-subscriptions/list-available-webhook-events.md)
- [Get a webhook subscription](https://docs.bird.com/api/notifications-api/api-reference/webhook-subscriptions/get-a-webhook-subscription.md)
- [List webhook subscriptions](https://docs.bird.com/api/notifications-api/api-reference/webhook-subscriptions/list-webhook-subscriptions.md)
- [Update a webhook subscription](https://docs.bird.com/api/notifications-api/api-reference/webhook-subscriptions/update-a-webhook-subscription.md)
- [Delete a webhook subscription](https://docs.bird.com/api/notifications-api/api-reference/webhook-subscriptions/delete-a-webhook-subscription.md)
- [Verifying a webhook subscription](https://docs.bird.com/api/notifications-api/api-reference/webhook-subscriptions/verifying-a-webhook-subscription.md)
- [Webhook subscription logs](https://docs.bird.com/api/notifications-api/api-reference/webhook-subscriptions/webhook-subscription-logs.md)
- [Knowledge Base (KB) API](https://docs.bird.com/api/knowledge-base-kb-api.md): This API enables question-answering based on your knowledge base articles.
- [API reference](https://docs.bird.com/api/knowledge-base-kb-api/api-reference.md): These are API related to knowledge base documents.
- [Documents](https://docs.bird.com/api/knowledge-base-kb-api/api-reference/documents.md): API for knowledge base documents
- [Folders](https://docs.bird.com/api/knowledge-base-kb-api/api-reference/folders.md)
- [Import](https://docs.bird.com/api/knowledge-base-kb-api/api-reference/folders/import.md): Import new knowledge base documents
- [Search](https://docs.bird.com/api/knowledge-base-kb-api/api-reference/search.md): API to do text search on a given workspace for knowledge base Documents.
- [Presigned upload](https://docs.bird.com/api/knowledge-base-kb-api/api-reference/presigned-upload.md): API to upload the template HTML content.
- [Email API](https://docs.bird.com/api/email-api.md)
- [Transmissions](https://docs.bird.com/api/email-api/transmissions.md)
- [Metrics](https://docs.bird.com/api/email-api/metrics.md)
- [Events](https://docs.bird.com/api/email-api/events.md)
- [Recipient Validation](https://docs.bird.com/api/email-api/recipient-validation.md)
- [Webhooks](https://docs.bird.com/api/email-api/webhooks.md)
- [Relay Webhooks](https://docs.bird.com/api/email-api/relay-webhooks.md)
- [Inbound Domains](https://docs.bird.com/api/email-api/inbound-domains.md)
- [Sending Domains](https://docs.bird.com/api/email-api/sending-domains.md)
- [Suppression List](https://docs.bird.com/api/email-api/suppression-list.md)
- [SMTP API](https://docs.bird.com/api/email-api/smtp-api.md)
- [Connectivity platform migration guide](https://docs.bird.com/api/connectivity-platform-migration-guide.md)
- [Channels API and Conversations API](https://docs.bird.com/api/connectivity-platform-migration-guide/channels-api-and-conversations-api.md)
- [Migrating conversations API actions](https://docs.bird.com/api/connectivity-platform-migration-guide/migrating-conversations-api-actions.md)
- [Migrating WhatsApp channels](https://docs.bird.com/api/connectivity-platform-migration-guide/migrating-whatsapp-channels.md)
- [Applications](https://docs.bird.com/api/client-sdks/applications.md)
- [Contact Profiles](https://docs.bird.com/api/client-sdks/contact-profiles.md)
- [Signed Identity](https://docs.bird.com/api/client-sdks/contact-profiles/signed-identity.md)
- [Chat widget attributes](https://docs.bird.com/api/client-sdks/chat-widget-attributes.md)
- [Push notifications](https://docs.bird.com/api/client-sdks/push-notifications.md)
- [Quick Start](https://docs.bird.com/api/client-sdks/push-notifications/quick-start.md)
- [Subscribe contacts to push notification campaigns](https://docs.bird.com/api/client-sdks/push-notifications/subscribe-contacts-to-push-notification-campaigns.md)
- [Notification Display Priority](https://docs.bird.com/api/client-sdks/push-notifications/notification-display-priority.md)
- [Event Tracking](https://docs.bird.com/api/client-sdks/event-tracking.md)
- [Quick Start](https://docs.bird.com/api/client-sdks/event-tracking/quick-start.md)
- [Track Events](https://docs.bird.com/api/client-sdks/event-tracking/track-events.md)
- [App](https://docs.bird.com/api/client-sdks/event-tracking/track-events/app.md)
- [Audiences](https://docs.bird.com/api/client-sdks/event-tracking/track-events/audiences.md)
- [Conference](https://docs.bird.com/api/client-sdks/event-tracking/track-events/conference.md)
- [Ecommerce](https://docs.bird.com/api/client-sdks/event-tracking/track-events/ecommerce.md)
- [Hospitality](https://docs.bird.com/api/client-sdks/event-tracking/track-events/hospitality.md)
- [Lists](https://docs.bird.com/api/client-sdks/event-tracking/track-events/lists.md)
- [Messaging](https://docs.bird.com/api/client-sdks/event-tracking/track-events/messaging.md)
- [Payments](https://docs.bird.com/api/client-sdks/event-tracking/track-events/payments.md)
- [Subscription](https://docs.bird.com/api/client-sdks/event-tracking/track-events/subscription.md)
- [Suppressions](https://docs.bird.com/api/client-sdks/event-tracking/track-events/suppressions.md)
- [Survey](https://docs.bird.com/api/client-sdks/event-tracking/track-events/survey.md)
- [Web](https://docs.bird.com/api/client-sdks/event-tracking/track-events/web.md)
- [App Inbox](https://docs.bird.com/api/client-sdks/app-inbox.md)
- [Quick Start](https://docs.bird.com/api/client-sdks/app-inbox/quick-start.md)
- [Usage](https://docs.bird.com/api/client-sdks/app-inbox/usage.md)
- [Subscribe contacts to app inbox campaigns](https://docs.bird.com/api/client-sdks/app-inbox/subscribe-contacts-to-app-inbox-campaigns.md)
- [SDK Integration](https://docs.bird.com/api/client-sdks/sdk-integration.md)
- [Android SDK](https://docs.bird.com/api/client-sdks/sdk-integration/android-sdk.md)
- [Notification Interactions](https://docs.bird.com/api/client-sdks/sdk-integration/android-sdk/notification-interactions.md)
- [Swift SDK](https://docs.bird.com/api/client-sdks/sdk-integration/swift-sdk.md)
- [Notification Interactions](https://docs.bird.com/api/client-sdks/sdk-integration/swift-sdk/notification-interactions.md)
- [Web SDK](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk.md)
- [Quick Start](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/quick-start.md)
- [Usage](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/usage.md)
- [API Reference](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/api-reference.md)
- [IdentityManager](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/api-reference/identitymanager.md)
- [BirdSdkApi](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/api-reference/birdsdkapi.md)
- [BirdTracker](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/api-reference/birdtracker.md)
- [Ecommerce](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/api-reference/birdtracker/ecommerce.md)
- [Conference](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/api-reference/birdtracker/conference.md)
- [Messaging](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/api-reference/birdtracker/messaging.md)
- [Suppressions](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/api-reference/birdtracker/suppressions.md)
- [Subscription](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/api-reference/birdtracker/subscription.md)
- [Survey](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/api-reference/birdtracker/survey.md)
- [Web](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/api-reference/birdtracker/web.md)
- [Audiences](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/api-reference/birdtracker/audiences.md)
- [Web Push Notifications](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/web-push-notifications.md): Push Notification is a Web SDK feature you could enable to bring the power of BirdCRM in building connected user experience to your website.
- [Notification Interactions](https://docs.bird.com/api/client-sdks/sdk-integration/web-sdk/web-push-notifications/notification-interactions.md)
- [Conversations](https://docs.bird.com/api/quickstarts/conversations.md): A walkthrough on how to use the Conversations API
- [Send an SMS message](https://docs.bird.com/api/quickstarts/send-an-sms-message.md): This guide provides instructions for setting up and sending SMS messages using Bird CRM.
- [Send an Email message](https://docs.bird.com/api/quickstarts/send-an-email-message.md): A walkthrough on setting up an email channel and using it
- [Send a WhatsApp message](https://docs.bird.com/api/quickstarts/send-a-whatsapp-message.md): This guide provides instructions for setting up and sending WhatsApp messages using Bird CRM.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.bird.com/api/welcome-to-the-bird-api-docs.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.