Management Commands
Commands for managing instances, automations, access control, webhooks, and the contact directory.omni instances
Manage channel connections. See Instances concept page for detailed documentation.
omni instances list # List all instances
omni instances get <id> # Get details
omni instances create [options] # Create a new instance
omni instances delete <id> # Delete an instance
omni instances status <id> # Connection status
omni instances whoami <id> # Show phone/identity
omni instances connect <id> # Connect
omni instances disconnect <id> # Disconnect
omni instances restart <id> # Restart
omni instances logout <id> # Logout and clear session
omni instances update <id> [options] # Update settings
WhatsApp Pairing
omni instances qr <id> # Display QR code
omni instances pair <id> --phone +5511999999999 # Pairing code
Sync and Contacts
omni instances sync <id> # Start sync
omni instances syncs <id> # List sync jobs
omni instances contacts <id> # List contacts
omni instances groups <id> # List groups
omni instances profile <id> <userId> # Get user profile
omni instances check <id> <phone> # Check WhatsApp registration
WhatsApp Account Management
Commands for managing the WhatsApp account associated with an instance.omni instances update-bio <id> <status> # Update profile bio/status
omni instances block <id> <contactId> # Block a contact
omni instances unblock <id> <contactId> # Unblock a contact
omni instances blocklist <id> # List blocked contacts
omni instances update-picture <id> [options] # Update profile picture
omni instances remove-picture <id> # Remove profile picture
omni instances privacy <id> # Fetch privacy settings
omni instances reject-call <id> [options] # Reject an incoming call
# Update your WhatsApp bio
omni instances update-bio wa-main "Support Bot — online 24/7"
# Block a spam contact
omni instances block wa-main 5511999999999@s.whatsapp.net
# Check who's blocked
omni instances blocklist wa-main
# Update profile picture from file
omni instances update-picture wa-main --file avatar.png
# View privacy settings
omni instances privacy wa-main
WhatsApp Group Management
Commands for creating and managing WhatsApp groups.omni instances group-create <id> [options] # Create a new group
omni instances group-update-picture <id> [options] # Update group picture
omni instances group-invite <id> <groupJid> # Get group invite link
omni instances group-revoke-invite <id> <groupJid> # Revoke and regenerate invite link
omni instances group-join <id> <code> # Join a group via invite code
# Create a new WhatsApp group
omni instances group-create wa-main --name "Project Team" --participants 5511999999999@s.whatsapp.net
# Get an invite link for a group
omni instances group-invite wa-main 120363123456789@g.us
# Revoke the current invite link and generate a new one
omni instances group-revoke-invite wa-main 120363123456789@g.us
# Join a group via invite code
omni instances group-join wa-main AbCdEfGh
omni automations
Manage event-driven workflows that trigger on message events.
omni automations list # List all automations
omni automations get <id> # Get details
omni automations create [options] # Create an automation
omni automations update <id> [options] # Update an automation
omni automations delete <id> # Delete
omni automations enable <id> # Enable
omni automations disable <id> # Disable
omni automations test <id> [options] # Test with mock event (dry run)
omni automations execute <id> [opts] # Execute with real event
omni automations logs <id> [options] # View execution logs
omni access
Manage access control rules — allow/deny lists for instances.
omni access list --instance <id> # List rules
omni access create [options] # Create a rule
omni access delete <id> # Delete a rule
omni access mode <instance-id> [mode] # Get/set access mode
omni access check [options] # Check if user has access
omni access pending <instance-id> # List pending requests
omni access approve <instance-id> <req-id> # Approve pairing request
omni access deny <instance-id> <req-id> # Deny pairing request
omni webhooks
Manage webhook event sources for custom integrations.
omni webhooks list # List webhook sources
omni webhooks get <id> # Get details
omni webhooks create [options] # Create a webhook source
omni webhooks update <id> [options] # Update
omni webhooks delete <id> # Delete
omni webhooks trigger [options] # Trigger a custom event
omni persons
Search and inspect contacts in the unified person directory.
omni persons search <query> # Search by name or phone
omni persons get <id> # Get full person profile
omni persons presence <id> # Check online presence and activity