Getting StartedAPI Reference
Getting StartedAPI Reference
  1. Campaign
  • Users
    • Get User
      GET
    • Onboard Business
      POST
    • Authenticate User
      GET
    • Delete User or Business
      DELETE
  • Wallet
    • Get Wallet Details
      GET
    • Topup wallet
      POST
  • Seed
    • Seed Leads
      POST
  • Campaign
    • Toggle Campaign Status
      PUT
  • Webhooks
    • Webhook Delivery
    • Events
      • website.eligibility
      • prospect.created
    • Webhoook Ops
      • Get all webhooks
      • Create Webhook Listener
      • Update Webhook Listener
      • Delete Webhook Listener
  1. Campaign

Toggle Campaign Status

Developing
PUT
/campaign/status
To switch our outbound efforts if you don't want to be billed anymore for the campaigns.

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://app.inboundiq.ai/api/v1/campaign/status' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "john.doe@example.com",
    "websiteUrl": "https://example.com",
    "enabled": true
}'
Response Response Example
{
    "status": 200,
    "message": "Outreach paused",
    "data": {
        "email": "john.doe@example.com",
        "websiteUrl": "https://example.com",
        "enabled": false
    }
}
Modified at 2025-12-11 12:08:22
Previous
Seed Leads
Next
Webhook Delivery
Built with