WhatsApp integration: operations for AI agents
WhatsApp connects to Type.com as an integration. This page lists the 113 operations documented for Claude and Codex in Type.com: 48 read, 53 write, 12 destructive.
About WhatsApp
Enables interaction with customers through the WhatsApp Business API for messaging and automation. Only supports WhatsApp Business accounts, not WhatsApp Personal accounts.
Categories: Email & Messaging
How to connect WhatsApp to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
113 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
113 operations listed.
Application Business Connections
- Read
Get Connected Client Businesses
Retrieve a list of client businesses connected to the specified application.
Multi Partner Solutions
- Read
Get Multi-Partner Solutions for Application
Retrieve all WhatsApp Business Multi-Partner Solutions associated with the specified application. This includes both solutions owned by the application and solutions where the application acts as a partner.
- Read
Get Multi-Partner Solution Access Token
Retrieve a granular BISU access token for accessing customer business resources through the Multi-Partner Solution. The token provides secure, scoped access to WhatsApp Business Accounts that have been shared with the solution.
- Read
Get Multi-Partner Solution Details
Retrieve comprehensive details about a Multi-Partner Solution, including its current status, pending status transitions, ownership information, and granted permissions.
- Read
List Multi-Partner Solutions for WABA
Retrieve a paginated list of Multi-Partner Solutions associated with the specified WhatsApp Business Account. This endpoint supports field selection and cursor-based pagination for efficient data retrieval.
- Write
Create Multi-Partner Solution
Create a new Multi-Partner Solution that defines permission distribution between a solution owner app and a partner app for WhatsApp Business messaging collaboration.
- Write
Accept Multi-Partner Solution Invitation
Accept an invitation to participate in a Multi-Partner Solution as a partner application. This endpoint transitions the partner's status from NOTIFICATIONSENT to ACCEPTED, enabling the solution to progress toward ACTIVE status once all required partners accept.
- Write
Reject Multi-Partner Solution Deactivation Request
Reject a pending deactivation request for a Multi-Partner Solution. This endpoint allows solution partners to decline deactivation requests from solution owners, maintaining the solution in its current active operational state.
- Write
Reject Multi-Partner Solution Request
Reject a pending partnership request or deactivation request for a Multi-Partner Solution. This endpoint allows solution owners to decline incoming requests and maintain control over their solution partnerships and lifecycle.
- Write
Send Multi-Partner Solution Deactivation Request
Submit a deactivation request for a Multi-Partner Solution. This initiates a workflow to transition the solution from its current state to deactivated, following proper business validation and approval processes.
Business Phone Numbers
- Write
Add Phone Number to Business Account
Add a preverified phone number to a WhatsApp Business Account. This endpoint is used by Partners to create a pool of Partner owned numbers that end clients can purchase.
Business Portfolio
- Read
Get Business Portfolio (Specific Fields)
Endpoint reference: Business
Pre Verified Phone Numbers
- Read
Get Pre-Verified Phone Numbers
Retrieve pre-verified phone numbers available for use with the specified business. This endpoint provides information about phone numbers that have been pre-verified and are ready for immediate use with WhatsApp Business messaging operations.
- Read
Get Pre-Verified Phone Number Details
Retrieve details about a specific pre-verified phone number, including validation status, formatting information, and any associated error messages.
- Write
Request Verification Code for Pre-Verified Phone Number
Request a verification code for a pre-verified phone number via SMS or voice call. This is part of the WhatsApp Business Account onboarding process where pre-approved phone numbers must be verified before they can be used for messaging. Process Flow: 1.
- Write
Verify OTP Code for Pre-Verified Phone Number
Verify the OTP code received for a pre-verified phone number to complete the verification process. This endpoint validates the code and updates the verification status of the phone number.
- Destructive
Delete Pre-Verified Phone Number
Delete a pre-verified phone number from the system. This operation removes the phone number from your pre-verified list and cannot be undone.
Client Whats App Business Accounts
- Read
Get Client WhatsApp Business Accounts
Retrieve a list of WhatsApp Business Accounts that have been shared with the specified business.
MM Lite Onboarding
- Write
Onboard Partners to MM Lite
Send a request from the partner to onboard an end business to MM Lite. This creates a business agreement request and sets OBO mobility intents on eligible WhatsApp Business Accounts. Business Flow: 1. Validates partner business and app permissions 2.
Owned Whats App Business Accounts
- Read
Get Owned WhatsApp Business Accounts
Retrieve WhatsApp Business Accounts owned by the specified business. This endpoint provides comprehensive information about all WABAs owned by the business, including account details, configuration, and status information.
Pre Verified Phone Number Sharing
Block Users
- Read
Get blocked users
- Guide: Block Users - Endpoint reference: GET WhatsApp Buiness Phone Number blockusers
- Write
Block user(s)
- Guide: Block Users - Endpoint reference: POST WhatsApp Buiness Phone Number blockusers
- Destructive
Unblock user(s)
- Guide: Block Users - Endpoint reference: DELETE WhatsApp Buiness Phone Number blockusers
Call Permissions
- Read
Check Call Permissions
Check whether you have permission to call a WhatsApp user and what actions are available. This endpoint returns the current permission status for calling a specific user, along with available actions and their limits.
Calls
- Write
Manage Calls
Use this endpoint to initiate, accept, reject, or terminate WhatsApp calls. For initiating or managing a call: Send a POST request with the appropriate action (connect, preaccept, accept, reject, terminate).
Groups
- Read
Get Active Groups
Retrieve a list of active groups for a given business phone number
- Write
Create Group
Create a new group and get an invite link
Marketing Messages
- Write
Send Marketing Template Message
Send marketing template messages using pre-approved templates. Supports optional product policy controls and message activity sharing settings.
Media
- Read
Retrieve Media URL
To retrieve your media’s URL, make a GET call to /{{Media-ID}}. Use the returned URL to download the media file. Note that clicking this URL (i.e. performing a generic GET) will not return the media; you must include an access token. For more information, see Download Media.
- Read
Download Media
Download media files using URLs obtained from media retrieval endpoints. Requires User Access Token with whatsappbusinessmessaging permission. Media URLs expire after 5 minutes and must be re-retrieved if expired. Returns binary content with appropriate MIME type headers.
- Write
Upload Image
This request uploads an image as .jpeg. The parameters are specified as form-data in the request body.
- Destructive
Delete Media
To delete media, make a DELETE call to the ID of the media you want to delete. Prerequisites - User Access Token with whatsappbusinessmessaging permission - Media object ID from either uploading media endpoint or media message Webhooks
Messages
- Write
Send Message.
Send Message.
QR Code Collection
- Read
List All Message QR Codes
Retrieve all message QR codes for a phone number, sorted by creation time (newest first). Supports field selection, filtering by code, cursor-based pagination, and QR image generation.
- Write
Create or Update Message QR Code
Create a new QR code (without code parameter) or update existing QR code (with code parameter). Supports optional QR image generation in PNG or SVG format.
Individual QR Code
- Read
Get Individual Message QR Code
Retrieve details for a specific QR code by its unique identifier. Supports field selection and QR image generation. Response returns QR code in data array for consistency.
- Destructive
Delete Individual Message QR Code
Permanently delete a specific QR code. Once deleted, the QR code and deep link become invalid. Deletion cannot be undone and affects any existing marketing materials using the QR code.
Encrypted Messages
- Write
Send Encrypted Message
Send encrypted messages using JWE (JSON Web Encryption) format. This endpoint provides an additional layer of security on top of existing standard TLS/SSL by accepting pre-encrypted message payloads and returning encrypted responses.
Official Business Account
- Read
Get Official Business Account Status
Retrieve the Official Business Account (OBA) status and related information for a WhatsApp Business Account phone number.
- Write
Update Official Business Account Status
Update or modify the Official Business Account (OBA) status for a WhatsApp Business Account phone number. This endpoint allows businesses to submit new applications, withdraw existing applications, or resubmit after addressing rejection reasons.
Phone Numbers
- Read
Retrieve WhatsApp Business Phone Number Information
Retrieve comprehensive information about a WhatsApp Business phone number using its unique ID (CSID). This endpoint provides phone number status, verification details, quality metrics, and configuration information.
- Write
Update WhatsApp Business Account Phone Number Status and Configuration
Update the status and configuration of a WhatsApp Business Account phone number. This endpoint supports comprehensive phone number management including status updates, webhook configuration, security settings, and business profile management.
Phone Number Management
- Read
Get WhatsApp Business Account Phone Numbers
Retrieve all phone numbers associated with a WhatsApp Business Account, including their status, verification details, and configuration information.
- Write
Deregister WhatsApp Business Phone Number
Deregister a WhatsApp Business phone number from the Facebook Hosted System. This operation removes the phone number from the WhatsApp Business Platform and makes it available for re-registration if needed.
- Write
Create WhatsApp Business Account Phone Number
Create a new phone number registration within a WhatsApp Business Account. This endpoint initiates the phone number onboarding process, including verification and business name approval.
Message History
- Read
Get WhatsApp Business Account Message History
Retrieve paginated message history for a WhatsApp Business Account phone number, including delivery status events, timestamps, and webhook update information.
Phone Number Registration
- Write
Register WhatsApp Business Phone Number
Register a WhatsApp Business phone number for messaging capabilities and enable two-step verification. This is a required step before sending messages through the WhatsApp Business Cloud API. Registration Process: 1. Phone number must be in UNVERIFIED status 2.
Phone Number Verification
- Write
Request Phone Number Verification Code
Request a verification code for a WhatsApp Business phone number via SMS or voice call. This is the first step in the phone number verification process.
- Write
Verify Phone Number Verification Code
Verify a phone number verification code for a WhatsApp Business Account phone number. This endpoint is used to complete the phone number verification process by submitting the verification code received via SMS or voice call.
Settings
- Read
Get phone number settings
Retrieve current settings for a WhatsApp Business phone number. Returns calling settings, payload encryption settings, and data storage configurations.
- Write
Update phone number settings
Update various settings for a WhatsApp Business phone number. You can configure calling settings, user identity change settings, payload encryption, and data storage configurations. Only one feature setting can be specified per request.
Flows
- Read
Get Business Encryption Public Key
Retrieve the current business public key and its signature verification status. This endpoint returns the public key that is currently configured for encrypting message payloads and indicates whether the stored signature is valid or has a mismatch.
- Read
List Flows
List Flows
- Read
Get Flow
Can request specific fields by enabling the \fields\ query param
- Read
List Assets (Get Flow JSON URL)
Returns all assets attached to the flow. Currently only FLOWJSON asset is supported
- Write
Create Flow
Creates a new flow. To clone an existing flow you can add the parameter "cloneflowid": "original-flow-id"
- Write
Migrate Flows
Creates a copy of existing flows from source WABA to destination WABA with the same names.
- Write
Update Flow Metadata
Update Flow Metadata
- Write
Update Flow JSON
Used to upload a flow JSON file with the flow content. Refer to flow JSON documentation here https://developers.facebook.com/docs/whatsapp/flows/reference/flowjson The file must be attached as from data. The response will include any validation errors in the JSON file
- Write
Publish Flow
Updates the status of the flow as "PUBLISHED". This action is not reversible. The flow and its assets become immutable once published. To update the flow, you must create a new flow and specify the previous flow id as the \cloneflowid\ parameter
- Write
Deprecate Flow
Updates the status of the flow as "DEPRECATED". This action is not reversible. Only a published flow can be deprecated to prevent sending or opening it.
- Write
Create authentication template w/ OTP copy code button
- Guide: Authentication Templates with OTP Buttons - Guide: Message Templates - Guide: How To Monitor Quality Signals - Endpoint reference: WhatsApp Business Account Message Templates
- Destructive
Delete Flow
Deletes the flow entirely. This action is not reversible. Only a DRAFT flow can be deleted.
Business Encryption
- Write
Set Business Encryption Public Key
Upload and configure a business public key for message payload encryption. This endpoint accepts a business public key in PEM format, validates it, and stores it with a cryptographic signature for future use in encrypting message payloads and data channel requests.
Whats App Business Profile
- Read
Get WhatsApp Business Profile
Retrieve comprehensive information about a WhatsApp Business Profile, including business details, contact information, and profile settings.
- Write
Update WhatsApp Business Profile
Update WhatsApp Business Profile information including business details, contact information, and profile settings.
Commerce Settings
- Read
Get commerce settings
- Guide: Sell Products & Services (Cloud API) - Guide: Sell Products & Services (On-Premises API) - Endpoint reference: WhatsApp Business Phone Number WhatsApp Commerce Settings
- Write
Set or update commerce settings
- Guide: Sell Products & Services (Cloud API) - Guide: Sell Products & Services (On-Premises API) - Endpoint reference: WhatsApp Business Phone Number WhatsApp Commerce Settings
Business Compliance
- Read
Get Business Compliance Information
Retrieve comprehensive business compliance information for a WhatsApp Business Account phone number, including entity details, registration status, and required contact information for regulatory compliance.
- Write
Update Business Compliance Information
Create or update comprehensive business compliance information for a WhatsApp Business Account phone number, including entity details, registration status, and required contact information for regulatory compliance.
Invite link
- Write
Create Group Invite Link
Create a new group invite link
- Destructive
Delete Group Invite Link
Delete an existing group invite link
Join requests
- Read
Get Join Requests
Get a list of open join requests for a group
- Write
Approve Join Requests
Approve one or more join requests
- Destructive
Reject Join Requests
Reject one or more join requests
Participants
- Write
Add Group Participants
Add participants to group
- Destructive
Remove Group Participants
Remove participants from group
General
- Read
Get Group Info
Retrieve metadata about a single group
- Write
Update Group Settings
Update the subject, description, and photo of a group
- Destructive
Delete Group
Delete the group and remove all participants, including the business
Message History Events
- Read
Get WhatsApp Message History Events
Retrieve paginated message delivery status events for a specific message history entry, including delivery status occurrences, timestamps, and application information.
Migration Intent
- Read
Get Migration Intent Details
Retrieve comprehensive details about a WhatsApp Business Account migration intent, including its current status and migration information.
Pre Verified Phone Number Partners
- Read
Get Pre-Verified Phone Number Partners
Retrieve the list of partner businesses that have been granted access to a specific WhatsApp Business Pre-Verified Phone Number.
Whats App Business Solution Management
- Write
Accept WhatsApp Business Solution Deactivation Request
Accepts a pending deactivation request for a WhatsApp Business Multi-Partner Solution. This endpoint completes the partner approval workflow by accepting a deactivation request that was previously initiated by another solution partner.
Assigned Whats App Business Accounts
- Read
Get Assigned WhatsApp Business Accounts
Retrieve WhatsApp Business Accounts that have been assigned to a specific user. This endpoint provides information about account assignments, permissions, and current status corresponding to the GraphAssignedWhatsAppBusinessAccountsEdge node.
Whats App Account Numbers
- Read
Get WhatsApp Account Number Details
Retrieve comprehensive details about a WhatsApp Account Number, including its current status, verification information, quality rating, and configuration settings.
Whats App Business Account Users
- Read
List Assigned Users
Retrieve a list of users assigned to the WhatsApp Business Account with their permissions and user details. This endpoint supports pagination and filtering capabilities.
- Write
Add User to WhatsApp Business Account
Add a user to the WhatsApp Business Account with specified permission tasks. This operation grants the user access to perform specific actions on the account based on the provided permission tasks.
- Destructive
Remove User from WhatsApp Business Account
Remove a user's access from the WhatsApp Business Account. This operation revokes all permissions and access rights for the specified user on the account.
Conversational Automation
- Write
Configure Conversational Automation
Configure conversational automation settings for a WhatsApp Business Account phone number, including welcome messages, conversation prompts (ice breakers), and bot commands.
Billing
- Read
Get credit lines
- Endpoint reference: Business Extendedcredits
Whats App Business Account On Behalf Requests
- Read
Get In-Progress On-Behalf Requests
Retrieve a list of in-progress on-behalf requests for the specified WhatsApp Business Account. These requests represent pending business relationship requests that have been sent from this WhatsApp Business Account to other businesses and are awaiting approval.
OBO Mobility Intent
- Read
Get OBO Mobility Intent Details
Retrieve details for a specific OBO Mobility Intent Node. This endpoint provides comprehensive information about the mobility intent, including current status, associated WABA and solution details, and operation history.
- Write
Create OBO Mobility Intent
Create a new On-Behalf-Of mobility intent for a WhatsApp Business Account. This endpoint allows authorized solution providers to initiate mobility operations on behalf of business accounts, facilitating transfers and handovers between different solution providers.
- Write
Set OBO Mobility Intent
Set On-Behalf-Of (OBO) mobility intent for a Multi-Partner Solution associated with a WhatsApp Business Account. This endpoint enables solution providers to establish OBO relationships for managing client WhatsApp Business Accounts.
Schedule Management
- Read
Get WhatsApp Business Account Schedules
Retrieve all schedules associated with a WhatsApp Business Account, including their configuration, status, and execution details.
- Write
Create WhatsApp Business Account Schedule
Create a new schedule configuration within a WhatsApp Business Account. This endpoint allows businesses to set up automated scheduling for various operations such as business hours, automated responses, and maintenance windows.
Solution Migration
- Write
Set Solution Migration Intent
Set migration intent for a Multi-Partner Solution associated with a WhatsApp Business Account. This endpoint allows solution partners to initiate, schedule, confirm, or cancel migration processes for their solutions.
Webhook Subscriptions
- Read
Get All Subscriptions for a WABA
Retrieve a list of all applications currently subscribed to webhook events for the specified WhatsApp Business Account.
- Write
Subscribe to WABA Webhooks
Subscribe your application to webhook events for the specified WhatsApp Business Account. This enables your app to receive real-time notifications for events such as message deliveries, status updates, and other WABA activities.
- Destructive
Unsubscribe from WABA Webhooks
Unsubscribe your application from webhook events for the specified WhatsApp Business Account. This will stop your app from receiving webhook notifications for this WABA.
Templates
- Read
Get template by ID (default fields)
- Guide: Message Templates - Guide: How To Monitor Quality Signals - Endpoint reference: WhatsApp Message Template
- Read
Get template by name (default fields)
- Guide: Message Templates - Guide: How To Monitor Quality Signals - Endpoint reference: WhatsApp Business Account Message Templates
- Write
Edit template
- Guide: Message Templates - Guide: How To Monitor Quality Signals - Endpoint reference: WhatsApp Message Template
- Destructive
Delete template by name
- Guide: Message Templates - Guide: How To Monitor Quality Signals - Endpoint reference: WhatsApp Business Account Message Templates
Whats App Business Account Activities
- Read
Get WhatsApp Business Account Activities
Retrieve activity logs and audit trails for a WhatsApp Business Account. This endpoint returns a chronological list of activities performed on the account, including administrative actions, configuration changes, and operational events.
Whats App Business Account
- Read
Get WhatsApp Business Account Details
Retrieve comprehensive details about a WhatsApp Business Account, including its configuration, status, and settings.
- Write
Update WhatsApp Business Account
Update configuration and settings for a WhatsApp Business Account.
Whats App Business Bot
- Read
Get WhatsApp Business Bot Details
Retrieve comprehensive details about a WhatsApp Business Bot, including its prompts, commands, and welcome message configuration.
Whats App Business Profiles
- Read
Get WhatsApp Business Profile Details
Retrieve comprehensive details about a WhatsApp Business Profile, including business information, contact details, and profile configuration.
- Write
Update WhatsApp Business Profile
Update the WhatsApp Business Profile information such as business description, email, address, and other profile details. This operation corresponds to the GraphWhatsAppBusinessProfilePost functionality.
- Write
Receive incoming WhatsApp messages
Endpoint for receiving webhook payloads for diverse incoming WhatsApp message types.
No operations match.
See How connections work for access and permissions, or browse all integrations.