Campaigns

List Campaigns

Lists all bulk sending campaigns/folders. Returns a plain array.

GEThttps://api.zapzapapi.com/api/v1/{instanceId}/sender/listfolders

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

Parameters

This endpoint takes no parameters.

Request example

curl

curl -X GET "https://api.zapzapapi.com/api/v1/{instanceId}/sender/listfolders" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/sender/listfolders", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
  },
});
console.log(await res.json());

Python

import requests

res = requests.get(
    "https://api.zapzapapi.com/api/v1/{instanceId}/sender/listfolders",
    headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
)
print(res.json())

Response example

JSON

[
  {
    "id": "r5819c9fba43b98",
    "info": "",
    "status": "scheduled",
    "scheduled_for": 1775449285668,
    "delayMax": 3,
    "delayMin": 1,
    "log_delivered": 0,
    "log_failed": 0,
    "log_played": 0,
    "log_read": 0,
    "log_sucess": 0,
    "log_total": 1,
    "owner": "5511999999999"
  }
]

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