# Chirp ## Docs - [Admin Keys](https://docs.buildwithchirp.com/administration_apis/admin-keys.md): Managing organization-level API keys - [Delete admin key](https://docs.buildwithchirp.com/api-reference/admin/delete-v1organizationadmin-keys.md): Delete an admin key from the organization - [Delete app key](https://docs.buildwithchirp.com/api-reference/admin/delete-v1organizationapp-keys.md): Delete an app key - [Delete app](https://docs.buildwithchirp.com/api-reference/admin/delete-v1organizationapps.md): Delete an app from the organization - [Remove phone number from app](https://docs.buildwithchirp.com/api-reference/admin/delete-v1organizationapps-phone-numbers.md): Remove a phone number from an app - [Delete webhook for app](https://docs.buildwithchirp.com/api-reference/admin/delete-v1organizationapps-webhooks.md): Delete a webhook from a specific app - [Cancel embedded signup session](https://docs.buildwithchirp.com/api-reference/admin/delete-v1organizationembedded-signupsessions.md): Cancel a pending embedded signup session. Only pending sessions can be cancelled. - [Delete phone number](https://docs.buildwithchirp.com/api-reference/admin/delete-v1organizationphone-numbers.md): Permanently delete a phone number from your organization. This will remove it from all apps. - [Disconnect business profile](https://docs.buildwithchirp.com/api-reference/admin/delete-v1organizationwhatsappbusiness-profiles.md): Disconnect a WhatsApp Business Profile from the organization. This performs a soft delete - the profile can be reconnected later. - [Delete template](https://docs.buildwithchirp.com/api-reference/admin/delete-v1organizationwhatsapptemplates.md): Delete a WhatsApp message template. This will also delete the template from Meta. - [Unlink template from app](https://docs.buildwithchirp.com/api-reference/admin/delete-v1organizationwhatsapptemplates-apps.md): Unlink a WhatsApp template from an app. The app will no longer receive webhook events for this template. - [List admin keys](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationadmin-keys.md): List all admin keys for the organization - [List app keys](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationapp-keys.md): List all app keys for the organization - [List apps](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationapps.md): List all apps in the organization - [Get calling configuration](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationapps-calling.md): Get calling configuration for an app - [List app phone numbers](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationapps-phone-numbers.md): List all phone numbers assigned to an app - [Get webhook for app](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationapps-webhooks.md): Get a specific webhook by ID for a specific app - [Check slug availability](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationappscheck-slug.md): Check if an app slug is available for use - [Get daily costs](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationbillingdaily-costs.md): Time series data for billing charts, optionally grouped by product, channel, or provider - [Get reconciliation report](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationbillingreconciliation.md): Compare stored billing records against Telnyx Usage Reports to detect drift - [Get billing record](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationbillingrecords.md): Get a single billing record with provider-specific details - [Get billing summary](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationbillingsummary.md): Get aggregated cost totals by product, channel, and direction for a date range - [List sync runs](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationbillingsync-runs.md): View billing sync run history with status and record counts - [Get embedded signup session](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationembedded-signupsessions.md): Get details of a specific embedded signup session. - [List organization phone numbers](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationphone-numbers.md): List all phone numbers owned by the organization - [List available phone numbers](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationphone-numbersavailable.md): List phone numbers available for purchase - [List playground SMS system numbers (org)](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationplaygroundphone-numberssystem.md): List the playground SMS system phone numbers assigned to a specific app within the organization. Pass the target app via the `x-app-id` header. - [List playground SMS user numbers (org)](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationplaygroundphone-numbersuser.md): List the playground SMS user phone numbers that have been used to simulate inbound messages across the organization. - [List playground WhatsApp system numbers (org)](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationplaygroundwhatsappphone-numberssystem.md): List the playground WhatsApp system phone numbers assigned to a specific app within the organization. Pass the target app via the `x-app-id` header. - [List playground WhatsApp user numbers (org)](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationplaygroundwhatsappphone-numbersuser.md): List the playground WhatsApp user phone numbers that have been used to simulate inbound messages across the organization. - [Get organization settings](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationsettings.md): Get organization-level settings like media retention - [List SMS messages](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationsmsmessages.md): List all SMS messages in the organization - [Get App Stats](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationstats.md): Get dashboard statistics for an app - [Get business profile](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationwhatsappbusiness-profiles.md): Get a specific WhatsApp Business Profile with its phone numbers - [List Recovered Signup Attempts](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationwhatsappbusiness-profilesrecovered-attempts.md): List signup attempts that were recovered via webhook (user completed signup on Meta but didn't return to Chirp). These need manual completion to finish setup. - [Get WhatsApp message](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationwhatsappmessages.md): Get a WhatsApp message by ID with full details and related data - [List WhatsApp phone numbers](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationwhatsappphone-numbers.md): List all WhatsApp phone numbers in the organization - [Get business profile](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationwhatsappphone-numbers-business-profile.md): Get the WhatsApp Business Profile for a phone number in your organization - [Get phone settings](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationwhatsappphone-numbers-settings.md): Get advanced phone settings including calling, encryption, and storage configuration for a phone number in your organization - [Get template](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationwhatsapptemplates.md): Get a specific WhatsApp message template - [List linked apps](https://docs.buildwithchirp.com/api-reference/admin/get-v1organizationwhatsapptemplates-apps.md): List all apps linked to a WhatsApp template. These apps receive webhook events for template lifecycle changes. - [Update organization settings](https://docs.buildwithchirp.com/api-reference/admin/patch-v1organizationsettings.md): Update organization-level settings like media retention - [Update business profile](https://docs.buildwithchirp.com/api-reference/admin/patch-v1organizationwhatsappphone-numbers-business-profile.md): Update the WhatsApp Business Profile for a phone number in your organization - [Update phone settings](https://docs.buildwithchirp.com/api-reference/admin/patch-v1organizationwhatsappphone-numbers-settings.md): Update advanced phone settings including calling, encryption, and storage configuration for a phone number in your organization - [Create admin key](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationadmin-keys.md): Create a new admin key for the organization - [Create app key](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationapp-keys.md): Create a new app key for an app - [Create app](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationapps.md): Create a new app in the organization - [Add phone number to app](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationapps-phone-numbers.md): Add a phone number to an app - [Create webhook for app](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationapps-webhooks.md): Create a new webhook for a specific app - [Trigger billing sync](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationbillingsync.md): Trigger an immediate billing sync by enqueuing detail and usage report sync jobs - [Create embedded signup session](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationembedded-signupsessions.md): Create a session for the embeddable WhatsApp Business signup flow. Returns a URL that expires in 15 minutes. Redirect your user to this URL to begin the signup process. - [Complete embedded signup session](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationembedded-signupsessions-complete.md): Complete the embedded signup flow by exchanging an OAuth authorization code OR by providing the WABA ID directly (for interrupted flows). The authorization code expires in 30 seconds. - [Purchase phone number](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationphone-numbers-purchase.md): Purchase a phone number and add it to an app - [Purchase a playground SMS system number (org)](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationplaygroundphone-numberssystem.md): Provision a new playground SMS system phone number for a specific app in the organization. Pass the target app via the `x-app-id` header. - [Generate a playground SMS user number (org)](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationplaygroundphone-numbersuser.md): Generate a new playground SMS user phone number that can be used as the sender when simulating an inbound SMS via the playground. - [Purchase a playground WhatsApp system number (org)](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationplaygroundwhatsappphone-numberssystem.md): Provision a new playground WhatsApp system phone number for a specific app in the organization. Pass the target app via the `x-app-id` header. - [Generate a playground WhatsApp user number (org)](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationplaygroundwhatsappphone-numbersuser.md): Generate a new playground WhatsApp user phone number that can be used as the sender when simulating an inbound WhatsApp message via the playground. - [Sync phone numbers](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationwhatsappbusiness-profiles-sync.md): Sync phone numbers from Meta for a WhatsApp Business Profile - [Complete Embedded Signup](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationwhatsappbusiness-profilescallback.md): Complete the Meta Embedded Signup flow by exchanging the authorization code for a business token. The authorization code expires in 30 seconds. - [Cancel Signup Attempt](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationwhatsappbusiness-profilescancel-attempt.md): Mark a signup attempt as cancelled when the user explicitly cancels the flow. - [Claim Recovered Signup Attempt](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationwhatsappbusiness-profilesclaim.md): Claim a recovered signup attempt to complete the WhatsApp Business Account connection. This is used when the user completed the Embedded Signup flow on Meta's side but didn't return to Chirp to finalize the setup. The attempt must be in 'recovered' status and belong to the authenticated organization… - [Fail Signup Attempt](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationwhatsappbusiness-profilesfail-attempt.md): Mark a signup attempt as failed when Meta returns an error during the Embedded Signup flow. This is different from cancellation (user-initiated) and preserves error details for debugging. - [Mark Signup Interrupted](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationwhatsappbusiness-profilesmark-interrupted.md): Record that a signup was interrupted after the user completed on Meta's side but before we received the auth code. This stores the WABA ID for recovery. - [Start Signup Attempt](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationwhatsappbusiness-profilesstart-attempt.md): Create a tracking record before launching Meta Embedded Signup. This enables orphan recovery if the user completes signup on Meta but doesn't return to Chirp. Optionally include a JSON body with `metadata` object to store developer-defined identifiers for filtering recovered attempts. - [Register WhatsApp phone number](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationwhatsappphone-numbers.md): Register a WhatsApp phone number with Meta's phone_number_id and optionally assign it to apps - [Register phone number with Meta Cloud API](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationwhatsappphone-numbers-cloud-api-register.md): Register the WhatsApp phone number with Meta's Cloud API using two-step verification. This is required before the phone number can be used for messaging. - [Create template](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationwhatsapptemplates.md): Create a new WhatsApp message template. The template will be submitted to Meta for review. - [Link template to app](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationwhatsapptemplates-apps.md): Link a WhatsApp template to an app. This allows the app to receive webhook events for template lifecycle changes (created, updated, deleted, approved, rejected, etc.). - [Send template message](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationwhatsapptemplatessend.md): Send a WhatsApp template message. The template must be approved by Meta. Variables can be passed using named keys that will be automatically mapped to positional indices. - [Sync templates](https://docs.buildwithchirp.com/api-reference/admin/post-v1organizationwhatsapptemplatessync.md): Sync WhatsApp message templates from Meta. This will add new templates, update existing ones, and remove deleted ones. - [Update app](https://docs.buildwithchirp.com/api-reference/admin/put-v1organizationapps.md): Update an app's configuration - [Update calling configuration](https://docs.buildwithchirp.com/api-reference/admin/put-v1organizationapps-calling.md): Create or update calling configuration for an app - [Update app phone number](https://docs.buildwithchirp.com/api-reference/admin/put-v1organizationapps-phone-numbers.md): Update a phone number's configuration for an app - [Update webhook for app](https://docs.buildwithchirp.com/api-reference/admin/put-v1organizationapps-webhooks.md): Update a webhook's configuration for a specific app - [Update phone number app assignments](https://docs.buildwithchirp.com/api-reference/admin/put-v1organizationphone-numbers-apps.md): Update which apps a phone number is assigned to - [Update business profile apps](https://docs.buildwithchirp.com/api-reference/admin/put-v1organizationwhatsappbusiness-profiles-apps.md): Update which apps are linked to a WhatsApp Business Profile - [Update WhatsApp phone number app assignments](https://docs.buildwithchirp.com/api-reference/admin/put-v1organizationwhatsappphone-numbers-apps.md): Update which apps a WhatsApp phone number is assigned to - [Update template](https://docs.buildwithchirp.com/api-reference/admin/put-v1organizationwhatsapptemplates.md): Update an existing WhatsApp message template's components. Only components can be updated - name, language, and category are immutable. After update, the template status resets to PENDING and requires Meta re-approval. - [End call](https://docs.buildwithchirp.com/api-reference/app/delete-v1calls.md): End an active call (alias for hangup command) - [Delete recording](https://docs.buildwithchirp.com/api-reference/app/delete-v1callsrecordings.md): Delete a call recording from storage and database - [Delete voicemail](https://docs.buildwithchirp.com/api-reference/app/delete-v1callsvoicemails.md): Delete a voicemail - [Delete media](https://docs.buildwithchirp.com/api-reference/app/delete-v1media.md): Delete a media file by ID - [Unassign phone number](https://docs.buildwithchirp.com/api-reference/app/delete-v1phone-numbers.md): Remove a phone number from the authenticated app - [Delete app webhook](https://docs.buildwithchirp.com/api-reference/app/delete-v1webhooks.md): Delete a webhook from the app - [Delete group](https://docs.buildwithchirp.com/api-reference/app/delete-v1whatsappgroups.md): Delete a WhatsApp group - [Remove participants](https://docs.buildwithchirp.com/api-reference/app/delete-v1whatsappgroups-participants.md): Remove participants from a WhatsApp group - [Delete app template](https://docs.buildwithchirp.com/api-reference/app/delete-v1whatsapptemplates.md): Delete a WhatsApp message template. This permanently deletes the template from Meta, which will affect ALL apps that have this template linked. The template cannot be recovered after deletion. - [Get call](https://docs.buildwithchirp.com/api-reference/app/get-v1calls.md): Get details for a specific call - [List call recordings](https://docs.buildwithchirp.com/api-reference/app/get-v1calls-recordings.md): List all recordings for a specific call - [Get recording](https://docs.buildwithchirp.com/api-reference/app/get-v1callsrecordings.md): Get a specific call recording by ID with a signed download URL - [Get voicemail](https://docs.buildwithchirp.com/api-reference/app/get-v1callsvoicemails.md): Get a specific voicemail by ID - [List functions](https://docs.buildwithchirp.com/api-reference/app/get-v1functions.md): List all serverless functions - [Get media](https://docs.buildwithchirp.com/api-reference/app/get-v1media.md): Get a specific media file by ID - [List playground SMS system numbers](https://docs.buildwithchirp.com/api-reference/app/get-v1playgroundphone-numberssystem.md): List the playground SMS system phone numbers assigned to your app. These numbers send and receive simulated traffic in the playground. - [List playground SMS user numbers](https://docs.buildwithchirp.com/api-reference/app/get-v1playgroundphone-numbersuser.md): List the playground SMS user phone numbers that have been used to simulate inbound messages to your app. - [List playground WhatsApp system numbers](https://docs.buildwithchirp.com/api-reference/app/get-v1playgroundwhatsappphone-numberssystem.md): List the playground WhatsApp system phone numbers assigned to your app. These numbers send and receive simulated WhatsApp traffic in the playground. - [List playground WhatsApp user numbers](https://docs.buildwithchirp.com/api-reference/app/get-v1playgroundwhatsappphone-numbersuser.md): List the playground WhatsApp user phone numbers that have been used to simulate inbound messages to your app. - [Get app webhook](https://docs.buildwithchirp.com/api-reference/app/get-v1webhooks.md): Get a specific webhook by ID for the authenticated app - [Get group](https://docs.buildwithchirp.com/api-reference/app/get-v1whatsappgroups.md): Get a WhatsApp group by ID - [Get invite link](https://docs.buildwithchirp.com/api-reference/app/get-v1whatsappgroups-invite-link.md): Get the invite link for a WhatsApp group - [List join requests](https://docs.buildwithchirp.com/api-reference/app/get-v1whatsappgroups-join-requests.md): List pending join requests for a WhatsApp group - [List participants](https://docs.buildwithchirp.com/api-reference/app/get-v1whatsappgroups-participants.md): List participants of a WhatsApp group - [Get business profile](https://docs.buildwithchirp.com/api-reference/app/get-v1whatsappphone-numbers-business-profile.md): Get the WhatsApp Business Profile for a phone number - [Get phone settings](https://docs.buildwithchirp.com/api-reference/app/get-v1whatsappphone-numbers-settings.md): Get advanced phone settings including calling, encryption, and storage configuration - [Get app template](https://docs.buildwithchirp.com/api-reference/app/get-v1whatsapptemplates.md): Get a specific WhatsApp message template linked to this app - [Update voicemail](https://docs.buildwithchirp.com/api-reference/app/patch-v1callsvoicemails.md): Update voicemail properties (e.g., mark as read) - [Update business profile](https://docs.buildwithchirp.com/api-reference/app/patch-v1whatsappphone-numbers-business-profile.md): Update the WhatsApp Business Profile for a phone number - [Update phone settings](https://docs.buildwithchirp.com/api-reference/app/patch-v1whatsappphone-numbers-settings.md): Update advanced phone settings including calling, encryption, and storage configuration - [Create call](https://docs.buildwithchirp.com/api-reference/app/post-v1calls.md): Initiate an outbound call - [Execute call command](https://docs.buildwithchirp.com/api-reference/app/post-v1calls-commands.md): Send a command to control an active call - [Generate call token](https://docs.buildwithchirp.com/api-reference/app/post-v1callstoken.md): Generate a LiveKit access token for WebRTC connections - [Create function](https://docs.buildwithchirp.com/api-reference/app/post-v1functions.md): Create a new serverless function - [Create function deployment](https://docs.buildwithchirp.com/api-reference/app/post-v1functions-deployments.md): Create a new deployment for the function - [Upload media](https://docs.buildwithchirp.com/api-reference/app/post-v1media.md): Upload a media file (image, video, audio, document, or sticker). Returns a mediaId that can be used when sending messages. - [Assign phone number](https://docs.buildwithchirp.com/api-reference/app/post-v1phone-numbers.md): Assign a phone number to the authenticated app - [Purchase a playground SMS system number](https://docs.buildwithchirp.com/api-reference/app/post-v1playgroundphone-numberssystem.md): Provision a new playground SMS system phone number for your app. The number can immediately be used to send and receive simulated playground messages. - [Generate a playground SMS user number](https://docs.buildwithchirp.com/api-reference/app/post-v1playgroundphone-numbersuser.md): Generate a new playground SMS user phone number that can be used as the sender when simulating an inbound SMS via the playground. - [Simulate inbound SMS](https://docs.buildwithchirp.com/api-reference/app/post-v1playgroundsmsinbound.md): Simulate an inbound SMS from a user to your application. Test apps only. The simulated message is processed by the same pipeline as real Telnyx webhooks and will trigger your configured `messages.sms.received` webhooks. - [Simulate inbound WhatsApp message](https://docs.buildwithchirp.com/api-reference/app/post-v1playgroundwhatsappinbound.md): Simulate an inbound WhatsApp text message from a user to your application. Test apps only. The simulated message is processed by the same pipeline as real Meta webhooks and will trigger your configured `messages.whatsapp.received` webhooks. - [Purchase a playground WhatsApp system number](https://docs.buildwithchirp.com/api-reference/app/post-v1playgroundwhatsappphone-numberssystem.md): Provision a new playground WhatsApp system phone number for your app. The number can immediately be used to send and receive simulated playground WhatsApp messages. - [Generate a playground WhatsApp user number](https://docs.buildwithchirp.com/api-reference/app/post-v1playgroundwhatsappphone-numbersuser.md): Generate a new playground WhatsApp user phone number that can be used as the sender when simulating an inbound WhatsApp message via the playground. - [Send SMS](https://docs.buildwithchirp.com/api-reference/app/post-v1sms.md): Send an SMS or MMS message - [Create app webhook](https://docs.buildwithchirp.com/api-reference/app/post-v1webhooks.md): Create a new webhook for the app - [Create group](https://docs.buildwithchirp.com/api-reference/app/post-v1whatsappgroups.md): Create a new WhatsApp group - [Reset invite link](https://docs.buildwithchirp.com/api-reference/app/post-v1whatsappgroups-invite-linkreset.md): Reset (revoke and regenerate) the invite link for a WhatsApp group - [Approve join requests](https://docs.buildwithchirp.com/api-reference/app/post-v1whatsappgroups-join-requestsapprove.md): Approve pending join requests for a WhatsApp group - [Reject join requests](https://docs.buildwithchirp.com/api-reference/app/post-v1whatsappgroups-join-requestsreject.md): Reject pending join requests for a WhatsApp group - [Send group message](https://docs.buildwithchirp.com/api-reference/app/post-v1whatsappgroups-messages.md): Send a message to a WhatsApp group - [Pin message](https://docs.buildwithchirp.com/api-reference/app/post-v1whatsappgroups-messagespin.md): Pin a message in a WhatsApp group - [Unpin message](https://docs.buildwithchirp.com/api-reference/app/post-v1whatsappgroups-messagesunpin.md): Unpin a message in a WhatsApp group - [Send WhatsApp Message](https://docs.buildwithchirp.com/api-reference/app/post-v1whatsappmessages.md): Send a WhatsApp message (text, media, template, or interactive) - [Mark Message as Read](https://docs.buildwithchirp.com/api-reference/app/post-v1whatsappmessagesread.md): Mark a WhatsApp message as read. This displays read receipts to the sender. - [Send Typing Indicator](https://docs.buildwithchirp.com/api-reference/app/post-v1whatsappmessagestyping.md): Show a typing indicator to the WhatsApp user. Also marks the message as read. The indicator will be dismissed after you send a response or after 25 seconds. - [Create app template](https://docs.buildwithchirp.com/api-reference/app/post-v1whatsapptemplates.md): Create a new WhatsApp message template. The template will be submitted to Meta for review and automatically linked to this app for webhook events. - [Send app template message](https://docs.buildwithchirp.com/api-reference/app/post-v1whatsapptemplatessend.md): Send a WhatsApp template message. The template must be approved by Meta and linked to this app. Variables can be passed using named keys that will be automatically mapped to positional indices. - [Update function](https://docs.buildwithchirp.com/api-reference/app/put-v1functions.md): Update a serverless function's configuration - [Update app webhook](https://docs.buildwithchirp.com/api-reference/app/put-v1webhooks.md): Update a webhook's configuration - [Update group](https://docs.buildwithchirp.com/api-reference/app/put-v1whatsappgroups.md): Update a WhatsApp group's subject or description - [Update profile picture](https://docs.buildwithchirp.com/api-reference/app/put-v1whatsappgroups-profile-picture.md): Update the profile picture of a WhatsApp group - [Update app template](https://docs.buildwithchirp.com/api-reference/app/put-v1whatsapptemplates.md): Update an existing WhatsApp message template's components. Only components can be updated - name, language, and category are immutable. After update, the template status resets to PENDING and requires Meta re-approval. - [App Keys](https://docs.buildwithchirp.com/api_reference/app-keys.md): Managing application-level API keys - [Authentication](https://docs.buildwithchirp.com/api_reference/authentication.md): Authenticate API requests with API keys - [Error Codes](https://docs.buildwithchirp.com/api_reference/error-codes.md): Complete reference of all Chirp API error codes with causes and solutions - [Errors](https://docs.buildwithchirp.com/api_reference/errors.md): Understand the structure and types of errors returned by the Chirp API - [Handling Errors](https://docs.buildwithchirp.com/api_reference/handling-errors.md): Learn how to handle API errors and webhook failures in your application - [API Introduction](https://docs.buildwithchirp.com/api_reference/introduction.md): Getting started with the Chirp API - [Playground Async API](https://docs.buildwithchirp.com/api_reference/playground-async-api.md) - [Rate Limits](https://docs.buildwithchirp.com/api_reference/rate-limits.md): Understanding API rate limits and best practices - [Webhook Event Reference](https://docs.buildwithchirp.com/api_reference/webhooks/events.md): Complete reference for every webhook event Chirp delivers, including payloads and trigger behavior - [Call Commands](https://docs.buildwithchirp.com/calling/call-commands.md): Control active calls with commands for hold, mute, transfer, recording, and more - [Making Calls](https://docs.buildwithchirp.com/calling/making-calls.md): Initiate outbound phone calls using the Chirp API - [Calling Overview](https://docs.buildwithchirp.com/calling/overview.md): Learn about making and receiving phone calls with Chirp - [Receiving Calls](https://docs.buildwithchirp.com/calling/receiving-calls.md): Handle inbound phone calls with webhooks and call commands - [Call Recordings](https://docs.buildwithchirp.com/calling/recordings.md): Record calls, download audio files, and manage recordings via the API - [Voicemails](https://docs.buildwithchirp.com/calling/voicemails.md): Receive, manage, and transcribe voicemails left by callers - [Webhooks Setup](https://docs.buildwithchirp.com/calling/webhooks-setup.md): Configure webhooks to receive real-time notifications about call events - [Applications](https://docs.buildwithchirp.com/concepts/applications.md): Organize your projects with isolated environments and API keys - [Media Access](https://docs.buildwithchirp.com/concepts/media-access.md): How to access media files from messages with presigned URLs and the Media API - [Phone Numbers](https://docs.buildwithchirp.com/concepts/phone-numbers.md): Purchase and manage dedicated phone numbers for your applications - [Playground](https://docs.buildwithchirp.com/concepts/playground.md): Test and debug your messages in a safe, sandbox environment - [Simulating Inbound Messages](https://docs.buildwithchirp.com/concepts/simulating-inbound-messages.md): Programmatically simulate inbound SMS and WhatsApp messages from a user to your application using the Playground inbound API - [Webhooks](https://docs.buildwithchirp.com/concepts/webhooks.md): Receive real-time HTTP notifications when events occur in your application - [Pricing](https://docs.buildwithchirp.com/getting_started/pricing.md): Simple, transparent pricing for SMS and MMS - [Quickstart](https://docs.buildwithchirp.com/getting_started/quickstart.md): Send your first SMS message in under 5 minutes - [Intro to Chirp](https://docs.buildwithchirp.com/index.md): Chirp is a modern CPaaS platform for SMS and MMS messaging. - [Privacy Policy](https://docs.buildwithchirp.com/resources/privacy-policy.md): Chirp privacy policy - [Terms of Service](https://docs.buildwithchirp.com/resources/terms-and-policies.md): Chirp terms of service and policies - [SMS Error Codes](https://docs.buildwithchirp.com/sms/error-codes.md): Understanding SMS and MMS delivery error codes - [Managing Phone Numbers](https://docs.buildwithchirp.com/sms/managing-numbers.md): Purchase and assign phone numbers to your applications - [SMS Overview](https://docs.buildwithchirp.com/sms/overview.md): Learn about SMS and MMS messaging with Chirp - [Receiving Messages](https://docs.buildwithchirp.com/sms/receiving-messages.md): Handle incoming SMS and MMS messages with webhooks - [Sending MMS](https://docs.buildwithchirp.com/sms/sending-messages/mms.md): Send messages with media attachments - [Multiple Recipients](https://docs.buildwithchirp.com/sms/sending-messages/multiple-recipients.md): Send the same message to multiple phone numbers - [Sending SMS](https://docs.buildwithchirp.com/sms/sending-messages/sms.md): Send text-only messages - [Webhooks Setup](https://docs.buildwithchirp.com/sms/webhooks-setup.md): Configure webhooks to receive real-time message notifications - [Embedded Signup](https://docs.buildwithchirp.com/whatsapp/embedded-signup.md): Connect WhatsApp Business Accounts using Meta's Embedded Signup flow - [Embedded Signup: Popup Flow](https://docs.buildwithchirp.com/whatsapp/embedded-signup-popup.md): Integrate WhatsApp account connection using Meta's client-side popup - [Embedded Signup: Redirect Flow](https://docs.buildwithchirp.com/whatsapp/embedded-signup-redirect.md): Integrate WhatsApp account connection using server-side redirects - [WhatsApp Error Codes](https://docs.buildwithchirp.com/whatsapp/error-codes.md): Complete mapping of Meta WhatsApp error codes to Chirp errors - [WhatsApp Groups](https://docs.buildwithchirp.com/whatsapp/groups.md): Create and manage WhatsApp groups via the Chirp API - [Managing WhatsApp Phone Numbers](https://docs.buildwithchirp.com/whatsapp/managing-numbers.md): Register and manage WhatsApp Business phone numbers - [WhatsApp Overview](https://docs.buildwithchirp.com/whatsapp/overview.md): Learn about WhatsApp Business messaging with Chirp - [Phone Settings](https://docs.buildwithchirp.com/whatsapp/phone-settings.md): Configure WhatsApp business profiles and phone number settings - [Receiving WhatsApp Messages](https://docs.buildwithchirp.com/whatsapp/receiving-messages.md): Handle incoming WhatsApp messages from your customers - [Sending Interactive Messages](https://docs.buildwithchirp.com/whatsapp/sending-messages/interactive.md): Send WhatsApp messages with buttons, lists, CTA URLs, location requests, and flows - [Sending Media Messages](https://docs.buildwithchirp.com/whatsapp/sending-messages/media.md): Send images, videos, audio, documents, stickers, locations, and contacts via WhatsApp - [Sending Reactions](https://docs.buildwithchirp.com/whatsapp/sending-messages/reactions.md): Add or remove emoji reactions on WhatsApp messages - [Sending Template Messages](https://docs.buildwithchirp.com/whatsapp/sending-messages/templates.md): Send pre-approved WhatsApp message templates - [Sending Text Messages](https://docs.buildwithchirp.com/whatsapp/sending-messages/text.md): Send plain text WhatsApp messages - [Managing WhatsApp Templates](https://docs.buildwithchirp.com/whatsapp/templates.md): Create, manage, and send WhatsApp message templates - [WhatsApp Webhooks Setup](https://docs.buildwithchirp.com/whatsapp/webhooks-setup.md): Configure webhooks to receive real-time WhatsApp notifications ## OpenAPI Specs - [openapi](https://docs.buildwithchirp.com/openapi.json) ## AsyncAPI Specs - [asyncapi](https://docs.buildwithchirp.com/asyncapi.json)