Cloud API: block users
WriteBlock one or more users for a given phone number.
Permissions and limits
Account permissions
- A Kapso project API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send and read official WhatsApp messages through Kapso, and manage templates, flows, contacts, conversations and broadcasts.
Explore 114 workflow actions for Kapso, including account permissions and operation limits.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Block one or more users for a given phone number.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Claim or change username
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a new WhatsApp Flow.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a new WhatsApp Flow for a phone number.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a new WhatsApp message template, or update an existing one.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Forwards dataset creation to Meta and remembers the returned dataset ID.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a draft flow.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a media file from WhatsApp.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a WhatsApp message template.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete username
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deprecate a published flow.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Retrieve the WhatsApp Business profile information.
Get the call permission state for a business phone number with a specific WhatsApp user.
Retrieve detailed information about a specific contact.
Retrieve detailed information about a specific conversation.
Get current username
Get flow JSON assets and URLs.
Retrieve detailed information about a specific flow.
Retrieve a single WhatsApp message by its message ID.
Retrieve a single WhatsApp message template by its ID.
Retrieve detailed information about a specific phone number.
Get reserved username suggestions
Returns Meta's dataset response and remembers the WABA-dataset association.
Retrieve the list of users blocked for a given phone number.
Retrieve a paginated list of WhatsApp voice calls.
Retrieve a paginated list of WhatsApp contacts for your project.
Retrieve a paginated list of WhatsApp conversations for a phone number.
List all WhatsApp Flows for a business account.
List all WhatsApp Flows for a phone number.
Retrieve a list of approved message templates for this phone number.
Retrieve a paginated list of WhatsApp messages for a phone number.
List all phone numbers associated with a business account.
Move a conversation between apps on a shared number.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Publish a flow.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a WhatsApp marketing template message.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a WhatsApp message to a recipient.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sends the original Meta Conversions API payload using the stored token of a current connection in your project.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unblock one or more previously blocked users for a given phone number.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update WhatsApp business profile information.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update flow name, categories, endpointuri, or applicationid.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update phone number settings.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add up to 1000 recipients to a draft broadcast.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Cancel a scheduled broadcast and return it to draft status.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Health check via Meta APIs and Kapso services.
Remove all recipients from a draft or scheduled broadcast.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Connect a WhatsApp number to this customer using Meta credentials.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a sharedemail destination with status pending and sends a verification email to the address.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a broadcast campaign in draft mode.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a new WhatsApp contact.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Assign a conversation to a team member.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create customer
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a new WhatsApp Flow.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Upload new flow JSON to create a new version.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates a definition for an event type.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Routes an event type to a team destination.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Permanently deletes the event definition and all recorded event emissions associated with it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes the route and cancels its pending deliveries.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete customer
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete phone number
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes the finding from the list.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Stores one timestamped project event.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Permanently erase a WhatsApp contact and all associated data (conversations, messages, media).
A repeated request may repeat the external action. Review the previous result before retrying a write.
Returns one finding with its metrics, related findings, latest verification, and latest investigation including causes and suggested fixes.
Get broadcast
Retrieve a WhatsApp contact by UUID, phone number, or business-scoped user ID.
Retrieve a single conversation with metadata.
Retrieve a specific assignment by ID.
Get customer
Returns the evidence behind a finding: daily history, source events, affected and comparison conversation IDs, co-occurring events, and the same data for any grouped findings.
Get flow
Returns version details including the flow JSON.
Get recent invocations of the entire data endpoint function.
Get logs from the entire data endpoint function.
Get the contact's marketing message preference on one WhatsApp number.
Retrieve a single message by its WhatsApp message ID (WAMID).
Get phone number
Returns charges recorded for this project across the portfolio's accounts, broken down by usage kind.
Returns charges recorded for this project on one WABA, broken down by usage kind (currently messaging and calling).
Get broadcast campaigns, most recent first.
Retrieve a paginated list of WhatsApp contacts for your project.
Get all assignments for a conversation, most recent first.
Query WhatsApp conversations with filters.
Returns customers in your project, most recent first.
View all display name change requests for this number, most recent first.
Returns the findings for the project associated with your API key, most recently qualified first.
Returns versions for a flow, most recent first.
Returns WhatsApp flows in your project, most recent first.
List the contact's marketing message preference on each of your WhatsApp numbers.
Query WhatsApp messages across all conversations.
The catalog of events you can route, ordered by category and name.
Get WhatsApp numbers in your project, most recent first.
Returns the WABAs in a Meta Business Portfolio that are visible to your project, each with its funding status.
Returns the event definitions registered for the project associated with your API key.
Returns project-scoped events for the project associated with your API key, newest first.
Returns all users who are members of your project.
Get recipients for this broadcast with delivery status.
Event types currently routed to team destinations, oldest first.
Returns the project's shared email destinations and the Slack channel destinations connected from the Kapso app, including pending and unhealthy ones.
Returns webhook delivery attempts for your project, most recent first.
Records the current metrics as a baseline and starts monitoring the finding.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Publish a draft flow to make it available for use.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Disables a shared email or Slack channel destination, deletes its routes, and cancels its pending deliveries.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Retrieve a project event definition
Check status of a display name change request.
Schedule a broadcast to send at a future time.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Start sending messages immediately.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Request a display name change.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates editable metadata for an event definition.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a broadcast status.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a WhatsApp contact's profile or metadata.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update an assignment's notes, reassign to another user, or deactivate (unassign).
A repeated request may repeat the external action. Review the previous result before retrying a write.
Close completed conversations or reopen them for follow-ups.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update customer
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update phone number
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
Inspect step outputs and confirm the result in Kapso. A saved workflow is not a completed provider action.