1. Accounts
Rocketlead
  • Welcome to RocketLead
  • Accounts
    • List WA accounts
      GET
    • Get account by ID
      GET
    • Get account activity
      GET
    • Register phone on WhatsApp
      POST
    • Connect WA account
      POST
    • Setup account profile
      POST
    • Toggle account pause state
      POST
    • Update account phase
      PATCH
    • Set account display name
      POST
    • Set account avatar
      POST
  • Campaigns
    • List campaigns
      GET
    • Create campaign
      POST
    • Get campaign by ID
      GET
    • Update campaign
      PATCH
    • Delete campaign
      DELETE
    • Add step to campaign
      POST
    • Update campaign step
      PATCH
    • Delete campaign step
      DELETE
    • Reorder campaign steps
      PUT
    • Upload campaign media
      POST
    • Send test message for a campaign step
      POST
    • Start campaign
      POST
    • Pause campaign
      POST
    • Add leads to campaign
      POST
    • List campaign leads
      GET
    • Bulk lead action
      POST
    • Import leads into campaign
      POST
    • Get campaign daily stats
      GET
    • Duplicate campaign
      POST
    • Archive campaign
      POST
  • Leads
    • List all leads
    • List all lead tags
    • Update a lead
    • Bulk delete leads
    • List custom field definitions
    • Create custom field definition
  • Lead Lists
    • List lead lists
    • Create lead list
    • Get lead list by ID
    • Delete lead list
    • List leads in a list
    • Add lead to list
    • Bulk import leads to list
  • Conversations
    • List conversations
    • Get conversation messages
    • Send message in conversation
    • Update conversation tags
    • Toggle conversation read status
    • Schedule a message
    • List scheduled messages
    • Cancel scheduled message
    • List conversation tags
    • Create conversation tag
    • Delete conversation tag
    • Bulk conversation action
    • Get contact by phone
    • Update contact
    • Send test message
  • Agents
    • List agents
    • Create agent
    • Get agent usage stats
    • Get agent by ID
    • Update agent
    • Delete agent
    • Test agent with a message
    • Get competitor analysis
    • Run competitor analysis
  • Warmup
    • Get warmup status
    • Pause warmup for account
    • Resume warmup for account
  • Credits
    • Get current credit balance
    • List credit transactions
  • Orders
    • Create a new order
    • List orders
    • Get order details
  • Provision
    • Start provisioning by requesting OTP
    • Verify OTP and complete provisioning
  • Settings
    • Get workspace settings
    • Update workspace settings
  • Knowledge Base
    • List knowledge base sources
    • Create knowledge base source
    • Discover links from URL
    • Delete knowledge base source
    • Re-ingest knowledge base source
    • Get source chunks
    • Get knowledge base stats
  1. Accounts

Toggle account pause state

POST
/api/v1/accounts/{id}/toggle-pause
Pause or resume a WhatsApp account. Paused accounts will not send or receive campaign messages.

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK
Default Response
This response does not have a body.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.rocketlead.com/api/v1/accounts//toggle-pause' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "paused": true
}'
Modified at 2026-05-11 16:19:00
Previous
Setup account profile
Next
Update account phase
Built with