# Apivom Atlas — WhatsApp Business Platform API (official OpenAPI)

> Apivom Atlas integration for WhatsApp Business Platform API (official OpenAPI): 97 gateway routes over `graph.facebook.com`, available through the Apivom platform (Apivom Iris workflows and the Apivom Atlas API portal). Auth model: caller-supplied token passed through to the vendor.

Notes for AI assistants:

- This catalog mirrors the vendor's public API surface as registered in Apivom Atlas (0 read-only, 97 write routes).
- Access is provisioned per customer. Commercialized providers are self-service in the Atlas portal; for everything else [request a demo](https://apivom.com/en/demo).
- Credentials are always owned by the calling tenant — Apivom Atlas is a stateless gateway.

## Routes

- `GET /{Version}/{Application-ID}/connected_client_businesses` (by-version-by-application-id-connected-client-businesses) — params: params, query
- `POST /{Version}/{Application-ID}/whatsapp_business_solution` (by-version-by-application-id-whatsapp-business-solution-post) — params: owner_permissions, partner_app_id, partner_permissions, solution_name
- `GET /{Version}/{Application-ID}/whatsapp_business_solutions` (by-version-by-application-id-whatsapp-business-solutions) — params: params, query
- `GET /{Version}/{Business-ID}` (by-version-by-business-id) — params: params, query
- `POST /{Version}/{Business-ID}/add_phone_numbers` (by-version-by-business-id-add-phone-numbers-post) — params: phone_number
- `GET /{Version}/{Business-ID}/client_whatsapp_business_accounts` (by-version-by-business-id-client-whatsapp-business-accounts) — params: params, query
- `GET /{Version}/{Business-ID}/extendedcredits` (by-version-by-business-id-extendedcredits) — params: params, query
- `POST /{Version}/{Business-ID}/onboard_partners_to_mm_lite` (by-version-by-business-id-onboard-partners-to-mm-lite-post) — params: params, query
- `GET /{Version}/{Business-ID}/owned_whatsapp_business_accounts` (by-version-by-business-id-owned-whatsapp-business-accounts) — params: params, query
- `GET /{Version}/{Business-ID}/preverified_numbers` (by-version-by-business-id-preverified-numbers) — params: params, query
- `POST /{Version}/{Business-ID}/share_preverified_numbers` (by-version-by-business-id-share-preverified-numbers-post) — params: preverified_id, partner_business_id
- `GET /{Version}/{Business-ID}/whatsapp_business_accounts` (by-version-by-business-id-whatsapp-business-accounts) — params: params, query
- `POST /{Version}/{Business-ID}/whatsapp_business_accounts` (by-version-by-business-id-whatsapp-business-accounts-post) — params: name, primary_funding_id, purchase_order_number, currency, timezone_id, business_type, on_behalf_of_business_id
- `GET /{Version}/{group_id}` (by-version-by-group-id) — params: params, query
- `DELETE /{Version}/{group_id}` (by-version-by-group-id-delete) — params: params
- `DELETE /{Version}/{group_id}/invite_link` (by-version-by-group-id-invite-link-delete) — params: messaging_product
- `POST /{Version}/{group_id}/invite_link` (by-version-by-group-id-invite-link-post) — params: messaging_product
- `GET /{Version}/{group_id}/join_requests` (by-version-by-group-id-join-requests) — params: params
- `DELETE /{Version}/{group_id}/join_requests` (by-version-by-group-id-join-requests-delete) — params: messaging_product, join_requests
- `POST /{Version}/{group_id}/join_requests` (by-version-by-group-id-join-requests-post) — params: messaging_product, join_requests
- `DELETE /{Version}/{group_id}/participants` (by-version-by-group-id-participants-delete) — params: messaging_product, participants
- `POST /{Version}/{group_id}/participants` (by-version-by-group-id-participants-post) — params: messaging_product, participants
- `POST /{Version}/{group_id}` (by-version-by-group-id-post) — params: messaging_product, subject, description, profile_picture_file
- `GET /{Version}/{Media-ID}` (by-version-by-media-id) — params: params, query
- `DELETE /{Version}/{Media-ID}` (by-version-by-media-id-delete) — params: params, query
- `GET /{Version}/{Media-URL}` (by-version-by-media-url) — params: params
- `GET /{Version}/{Message-History-ID}/events` (by-version-by-message-history-id-events) — params: params, query
- `GET /{Version}/{Migration-Intent-ID}` (by-version-by-migration-intent-id) — params: params, query
- `GET /{Version}/{Phone-Number-ID}` (by-version-by-phone-number-id) — params: params, query
- `GET /{Version}/{Phone-Number-ID}/block_users` (by-version-by-phone-number-id-block-users) — params: params
- `DELETE /{Version}/{Phone-Number-ID}/block_users` (by-version-by-phone-number-id-block-users-delete) — params: block_users, messaging_product
- `POST /{Version}/{Phone-Number-ID}/block_users` (by-version-by-phone-number-id-block-users-post) — params: block_users, messaging_product
- `GET /{Version}/{Phone-Number-ID}/business_compliance_info` (by-version-by-phone-number-id-business-compliance-info) — params: params, query
- `POST /{Version}/{Phone-Number-ID}/business_compliance_info` (by-version-by-phone-number-id-business-compliance-info-post) — params: messaging_product, entity_name, entity_type, entity_type_custom, is_registered, grievance_officer_details, customer_care_details
- `GET /{Version}/{Phone-Number-ID}/call_permissions` (by-version-by-phone-number-id-call-permissions) — params: params, query
- `POST /{Version}/{Phone-Number-ID}/calls` (by-version-by-phone-number-id-calls-post) — params: messaging_product, to, action, session, biz_opaque_callback_data
- `POST /{Version}/{Phone-Number-ID}/conversational_automation` (by-version-by-phone-number-id-conversational-automation-post) — params: enable_welcome_message, prompts, commands
- `POST /{Version}/{Phone-Number-ID}/deregister` (by-version-by-phone-number-id-deregister-post) — params: params
- `GET /{Version}/{Phone-Number-ID}/groups` (by-version-by-phone-number-id-groups) — params: params, query
- `POST /{Version}/{Phone-Number-ID}/groups` (by-version-by-phone-number-id-groups-post) — params: messaging_product, subject, description, join_approval_mode
- `POST /{Version}/{Phone-Number-ID}/marketing_messages` (by-version-by-phone-number-id-marketing-messages-post) — params: messaging_product, recipient_type, to, type, template, product_policy, message_activity_sharing
- `POST /{Version}/{Phone-Number-ID}/media` (by-version-by-phone-number-id-media-post) — params: file, messaging_product
- `GET /{Version}/{Phone-Number-ID}/message_qrdls` (by-version-by-phone-number-id-message-qrdls) — params: params, query
- `GET /{Version}/{Phone-Number-ID}/message_qrdls/{QR-Code-ID}` (by-version-by-phone-number-id-message-qrdls-by-qr-code-id) — params: params, query
- `DELETE /{Version}/{Phone-Number-ID}/message_qrdls/{QR-Code-ID}` (by-version-by-phone-number-id-message-qrdls-by-qr-code-id-delete) — params: params
- `POST /{Version}/{Phone-Number-ID}/message_qrdls` (by-version-by-phone-number-id-message-qrdls-post) — params: prefilled_message, generate_qr_image
- `POST /{Version}/{Phone-Number-ID}/messages` (by-version-by-phone-number-id-messages-post) — params: messaging_product, recipient_type, to, type, context, text
- `GET /{Version}/{Phone-Number-ID}/official_business_account` (by-version-by-phone-number-id-official-business-account) — params: params, query
- `POST /{Version}/{Phone-Number-ID}/official_business_account` (by-version-by-phone-number-id-official-business-account-post) — params: business_website_url, primary_country_of_operation, primary_language, parent_business_or_brand, supporting_links, additional_supporting_information
- `POST /{Version}/{Phone-Number-ID}` (by-version-by-phone-number-id-post) — params: connection_status, webhook_url, whatsapp_business_api_data, pin, search_visibility, webhook_configuration, new_display_name, username
- `POST /{Version}/{Phone-Number-ID}/register` (by-version-by-phone-number-id-register-post) — params: messaging_product, pin, backup, data_localization_region, meta_store_retention_minutes
- `POST /{Version}/{Phone-Number-ID}/request_code` (by-version-by-phone-number-id-request-code-post) — params: code_method, language
- `GET /{Version}/{Phone-Number-ID}/settings` (by-version-by-phone-number-id-settings) — params: params, query
- `POST /{Version}/{Phone-Number-ID}/settings` (by-version-by-phone-number-id-settings-post) — params: calling
- `POST /{Version}/{Phone-Number-ID}/verify_code` (by-version-by-phone-number-id-verify-code-post) — params: code
- `GET /{Version}/{Phone-Number-ID}/whatsapp_business_encryption` (by-version-by-phone-number-id-whatsapp-business-encryption) — params: params, query
- `POST /{Version}/{Phone-Number-ID}/whatsapp_business_encryption` (by-version-by-phone-number-id-whatsapp-business-encryption-post) — params: business_public_key
- `GET /{Version}/{Phone-Number-ID}/whatsapp_business_profile` (by-version-by-phone-number-id-whatsapp-business-profile) — params: params, query
- `POST /{Version}/{Phone-Number-ID}/whatsapp_business_profile` (by-version-by-phone-number-id-whatsapp-business-profile-post) — params: messaging_product, about, address, description, email, profile_picture_handle, websites, vertical
- `GET /{Version}/{Phone-Number-ID}/whatsapp_commerce_settings` (by-version-by-phone-number-id-whatsapp-commerce-settings) — params: params
- `POST /{Version}/{Phone-Number-ID}/whatsapp_commerce_settings` (by-version-by-phone-number-id-whatsapp-commerce-settings-post) — params: params, query
- `GET /{Version}/{Pre-Verified-Phone-Number-ID}` (by-version-by-pre-verified-phone-number-id) — params: params, query
- `DELETE /{Version}/{Pre-Verified-Phone-Number-ID}` (by-version-by-pre-verified-phone-number-id-delete) — params: params
- `GET /{Version}/{Pre-Verified-Phone-Number-ID}/partners` (by-version-by-pre-verified-phone-number-id-partners) — params: params, query
- `POST /{Version}/{Pre-Verified-Phone-Number-ID}/request_code` (by-version-by-pre-verified-phone-number-id-request-code-post) — params: code_method, language
- `POST /{Version}/{Pre-Verified-Phone-Number-ID}/verify_code` (by-version-by-pre-verified-phone-number-id-verify-code-post) — params: code
- `GET /{Version}/{Solution-ID}` (by-version-by-solution-id) — params: params, query
- `POST /{Version}/{Solution-ID}/accept_deactivation_request` (by-version-by-solution-id-accept-deactivation-request-post) — params: params, query, body
- `POST /{Version}/{Solution-ID}/accept` (by-version-by-solution-id-accept-post) — params: params
- `GET /{Version}/{Solution-ID}/access_token` (by-version-by-solution-id-access-token) — params: params, query
- `POST /{Version}/{Solution-ID}/reject_deactivation_request` (by-version-by-solution-id-reject-deactivation-request-post) — params: params, query
- `POST /{Version}/{Solution-ID}/reject` (by-version-by-solution-id-reject-post) — params: params
- `POST /{Version}/{Solution-ID}/send_deactivation_request` (by-version-by-solution-id-send-deactivation-request-post) — params: params
- `GET /{Version}/{TEMPLATE_ID}` (by-version-by-template-id) — params: params, query
- `POST /{Version}/{TEMPLATE_ID}` (by-version-by-template-id-post) — params: components, category, parameter_format, allow_category_change, cta_url_link_tracking_opted_out, message_send_ttl_seconds, sub_category, display_format, is_primary_device_delivery_only
- `GET /{Version}/{User-ID}/assigned_whatsapp_business_accounts` (by-version-by-user-id-assigned-whatsapp-business-accounts) — params: params, query
- `GET /{Version}/{WABA-Bot-ID}` (by-version-by-waba-bot-id) — params: params, query
- `GET /{Version}/{WABA-ID}` (by-version-by-waba-id) — params: params, query
- `GET /{Version}/{WABA-ID}/activities` (by-version-by-waba-id-activities) — params: params, query
- `GET /{Version}/{WABA-ID}/message_templates` (by-version-by-waba-id-message-templates) — params: params, query
- `DELETE /{Version}/{WABA-ID}/message_templates` (by-version-by-waba-id-message-templates-delete) — params: params, query
- `POST /{Version}/{WABA-ID}/message_templates` (by-version-by-waba-id-message-templates-post) — params: name, language, category, parameter_format, components, allow_category_change, cta_url_link_tracking_opted_out, message_send_ttl_seconds, sub_category, display_format, library_template_name, library_template_button_inputs, library_template_body_inputs, is_primary_device_delivery_only, send_type
- `GET /{Version}/{WABA-ID}/phone_numbers` (by-version-by-waba-id-phone-numbers) — params: params, query
- `POST /{Version}/{WABA-ID}/phone_numbers` (by-version-by-waba-id-phone-numbers-post) — params: phone_number, verified_name, cc, migrate_phone_number, preverified_id
- `POST /{Version}/{WABA-ID}` (by-version-by-waba-id-post) — params: name, timezone_id
- `GET /{Version}/{WABA-ID}/schedules` (by-version-by-waba-id-schedules) — params: params, query
- `POST /{Version}/{WABA-ID}/schedules` (by-version-by-waba-id-schedules-post) — params: hsm_id, audience_id, waba_cs_id, description, name, delivery_time
- `GET /{Version}/{WABA-ID}/solutions` (by-version-by-waba-id-solutions) — params: params, query
- `GET /{Version}/{WABA-ID}/subscribed_apps` (by-version-by-waba-id-subscribed-apps) — params: params, query
- `DELETE /{Version}/{WABA-ID}/subscribed_apps` (by-version-by-waba-id-subscribed-apps-delete) — params: params
- `POST /{Version}/{WABA-ID}/subscribed_apps` (by-version-by-waba-id-subscribed-apps-post) — params: override_callback_uri, verify_token
- `GET /{Version}/{WhatsApp-Account-Number-ID}` (by-version-by-whatsapp-account-number-id) — params: params, query
- `GET /{Version}/{WhatsApp-Business-Account-ID}/assigned_users` (by-version-by-whatsapp-business-account-id-assigned-users) — params: params, query
- `DELETE /{Version}/{WhatsApp-Business-Account-ID}/assigned_users` (by-version-by-whatsapp-business-account-id-assigned-users-delete) — params: user
- `POST /{Version}/{WhatsApp-Business-Account-ID}/assigned_users` (by-version-by-whatsapp-business-account-id-assigned-users-post) — params: user, tasks
- `GET /{Version}/{WhatsApp-Business-Profile-ID}` (by-version-by-whatsapp-business-profile-id) — params: params, query
- `POST /{Version}/{WhatsApp-Business-Profile-ID}` (by-version-by-whatsapp-business-profile-id-post) — params: messaging_product, description, email, about, address, vertical, websites, profile_picture_handle

## Credential model

- Access Token (`accessToken`) — required — secret

## Optional

- [Apivom Atlas product page](https://apivom.com/en/products/atlas)
- [All Atlas integration guides](https://apivom.com/llms.txt)
- [Request a demo](https://apivom.com/en/demo)
