Campaigns

Control Campaign

Controls a bulk sending campaign: pause, resume or cancel.

POSThttps://api.zapzapapi.com/api/v1/{instanceId}/sender/edit

Authentication with the x-api-key and x-api-secret headers.

Parameters

Name	Type	In	Required	Description
`folder_id`	text	body	Yes	Unique identifier of the sending campaign
`action`	select	body	Yes	Campaign action

Request example

curl

curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/sender/edit" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"folder_id":"folder_123","action":"stop"}'

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/sender/edit", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "folder_id": "folder_123",
    "action": "stop"
  }),
});
console.log(await res.json());

Python

import requests

res = requests.post(
    "https://api.zapzapapi.com/api/v1/{instanceId}/sender/edit",
    headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
    json={"folder_id":"folder_123","action":"stop"},
)
print(res.json())

Response example

JSON

{
  "message": "Folder deletion has been initiated",
  "status": "deleting"
}

Values are illustrative; the fields follow the real response format.

Other endpoints in this category

See the full reference

Get your API keys

Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.

Create free account View the documentation