Campanhas

Campanhas com modelos aprovados pela Meta: criar, escolher o público, ver o custo antes de enviar, enviar agora, agendar ou escalonar, pausar e retomar.

Listar campanhas

GET/campaigns

Campanhas com seu status, número remetente, modelo e números (stats: enviados, entregues, lidos, respondidos, falhos). Abas (tab): all, sending, scheduled, drafts, errors, finished. summary resume o período (days).

Permissões: campaigns:read

Parâmetros

Nome	Onde	Tipo	Valores
`page`	consulta	number	padrão: `1` · 1 – …
`pageSize`	consulta	number	padrão: `20` · 1 – 100
`tab`	consulta	string	`all` · `sending` · `scheduled` · `drafts` · `errors` · `finished`
`category`	consulta	string	`MARKETING` · `UTILITY` · `AUTHENTICATION`
`phoneNumberId`	consulta	uuid
`q`	consulta	string	0–100 caracteres
`days`	consulta	number	1 – 365

curl

curl "https://micuenta.whatsmarketing.es/api/v1/campaigns?page=1&pageSize=20" \
  -H "Authorization: Bearer $WM_API_KEY"

Node.js

const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/campaigns?page=1&pageSize=20', {
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
  },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://micuenta.whatsmarketing.es/api/v1/campaigns?page=1&pageSize=20",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
data = r.json()

PHP

<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/campaigns?page=1&pageSize=20');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
  ],
]);
$data = json_decode(curl_exec($ch), true);

Resposta 200

{
  "data": [
    {
      "id": "3a4b5c6d-7e8f-4a9b-8c0d-1e2f3a4b5c6d",
      "organizationId": "f0e1d2c3-b4a5-4968-8776-655443322110",
      "phoneNumberId": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
      "templateId": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
      "name": "Octubre: promo",
      "status": "COMPLETED",
      "scheduledAt": null,
      "startedAt": "2026-10-10T08:00:00.000Z",
      "completedAt": "2026-10-10T08:12:00.000Z",
      "batchSize": null,
      "batchIntervalMin": null,
      "nextBatchAt": null,
      "pausedAt": null,
      "stopReason": null,
      "sourceCampaignId": null,
      "createdAt": "2026-10-09T16:00:00.000Z",
      "updatedAt": "2026-10-10T08:12:00.000Z",
      "template": {
        "name": "promo_octubre",
        "category": "MARKETING",
        "language": "es"
      },
      "phoneNumber": {
        "numberE164": "+34600000000",
        "displayName": "Clínica Sol"
      },
      "stats": {
        "total": 1200,
        "pending": 0,
        "sent": 1200,
        "delivered": 1174,
        "read": 803,
        "replied": 96,
        "failed": 26,
        "progressPct": 100
      }
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 1,
    "totalPages": 1
  },
  "tabs": {
    "all": 1,
    "sending": 0,
    "scheduled": 0,
    "drafts": 0,
    "errors": 0,
    "finished": 1
  },
  "summary": {
    "days": 30,
    "since": "2026-09-14",
    "campaigns": 1,
    "sent": 1200,
    "deliveredPct": 97.8,
    "readPct": 66.9,
    "replies": 96,
    "repliesPct": 8,
    "spend": 59.85,
    "spendPerMessage": 0.05
  }
}

Criar uma campanha (rascunho)

POST/campaigns

Nome, número remetente e modelo aprovado. Se o modelo tiver variáveis, variables diz de onde sai cada uma (campo do contato como {{fullName}} ou texto fixo); sem elas, o envio responde 400 CAMPAIGN_VARIABLES_REQUIRED. A campanha nasce como rascunho: depois adicione o público, consulte o custo e envie.

Permissões: campaigns:write

Corpo da requisição CreateCampaign

Nome	Tipo	Valores
`name` obrigatório	string	2–… caracteres
`phoneNumberId` obrigatório	uuid
`templateId` obrigatório	uuid
`scheduledAt`	string
`variables`	object

curl

curl -X POST "https://micuenta.whatsmarketing.es/api/v1/campaigns" \
  -H "Authorization: Bearer $WM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Octubre: promo",
  "phoneNumberId": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
  "templateId": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
  "variables": {
    "1": "{{fullName}}",
    "2": "15 %"
  }
}'

Node.js

const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/campaigns', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Octubre: promo",
    "phoneNumberId": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
    "templateId": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
    "variables": {
      "1": "{{fullName}}",
      "2": "15 %"
    }
  }),
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://micuenta.whatsmarketing.es/api/v1/campaigns",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    json={
        "name": "Octubre: promo",
        "phoneNumberId": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
        "templateId": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
        "variables": {
            "1": "{{fullName}}",
            "2": "15 %"
        }
    },
    timeout=30,
)
r.raise_for_status()
data = r.json()

PHP

<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/campaigns');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Octubre: promo',
    'phoneNumberId' => 'c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f',
    'templateId' => 'e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b',
    'variables' => [
      '1' => '{{fullName}}',
      '2' => '15 %'
    ]
  ]),
]);
$data = json_decode(curl_exec($ch), true);

Resposta 201

{
  "id": "3a4b5c6d-7e8f-4a9b-8c0d-1e2f3a4b5c6d",
  "organizationId": "f0e1d2c3-b4a5-4968-8776-655443322110",
  "phoneNumberId": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
  "templateId": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
  "name": "Octubre: promo",
  "status": "DRAFT",
  "scheduledAt": null,
  "startedAt": null,
  "completedAt": null,
  "batchSize": null,
  "batchIntervalMin": null,
  "nextBatchAt": null,
  "pausedAt": null,
  "stopReason": null,
  "sourceCampaignId": null,
  "createdAt": "2026-10-09T16:00:00.000Z",
  "updatedAt": "2026-10-09T16:00:00.000Z",
  "template": {
    "id": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
    "name": "promo_octubre",
    "category": "MARKETING",
    "language": "es",
    "bodyText": "Hola {{1}}, este mes tienes un {{2}} de descuento.",
    "status": "APPROVED"
  },
  "phoneNumber": {
    "id": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
    "numberE164": "+34600000000",
    "displayName": "Clínica Sol",
    "qualityRating": "GREEN"
  },
  "estimatedCost": null,
  "realCost": 0,
  "stats": {
    "total": 0,
    "pending": 0,
    "sent": 0,
    "delivered": 0,
    "read": 0,
    "replied": 0,
    "failed": 0,
    "progressPct": 0
  },
  "errorsByReason": [],
  "lastReplies": []
}

Ver uma campanha

GET/campaigns/{id}

Detalhe com números, modelo, número, agendamento, custo estimado e real, erros agrupados por motivo e últimas respostas.

Permissões: campaigns:read

Parâmetros

Nome	Onde	Tipo	Valores
`id` obrigatório	rota	string

curl

curl "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}" \
  -H "Authorization: Bearer $WM_API_KEY"

Node.js

const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}', {
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
  },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
data = r.json()

PHP

<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
  ],
]);
$data = json_decode(curl_exec($ch), true);

Resposta 200

{
  "id": "3a4b5c6d-7e8f-4a9b-8c0d-1e2f3a4b5c6d",
  "organizationId": "f0e1d2c3-b4a5-4968-8776-655443322110",
  "phoneNumberId": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
  "templateId": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
  "name": "Octubre: promo",
  "status": "DRAFT",
  "scheduledAt": null,
  "startedAt": null,
  "completedAt": null,
  "batchSize": null,
  "batchIntervalMin": null,
  "nextBatchAt": null,
  "pausedAt": null,
  "stopReason": null,
  "sourceCampaignId": null,
  "createdAt": "2026-10-09T16:00:00.000Z",
  "updatedAt": "2026-10-09T16:00:00.000Z",
  "template": {
    "id": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
    "name": "promo_octubre",
    "category": "MARKETING",
    "language": "es",
    "bodyText": "Hola {{1}}, este mes tienes un {{2}} de descuento.",
    "status": "APPROVED"
  },
  "phoneNumber": {
    "id": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
    "numberE164": "+34600000000",
    "displayName": "Clínica Sol",
    "qualityRating": "GREEN"
  },
  "estimatedCost": null,
  "realCost": 0,
  "stats": {
    "total": 0,
    "pending": 0,
    "sent": 0,
    "delivered": 0,
    "read": 0,
    "replied": 0,
    "failed": 0,
    "progressPct": 0
  },
  "errorsByReason": [],
  "lastReplies": []
}

Destinatários de uma campanha

GET/campaigns/{id}/recipients

Cada destinatário com seu status (PENDING, SENT, DELIVERED, READ, REPLIED, FAILED), o mercado pelo qual foi tarifado, o custo e o motivo da falha, se houve. filter restringe por status.

Permissões: campaigns:read

Parâmetros

Nome	Onde	Tipo	Valores
`id` obrigatório	rota	string
`page`	consulta	number	padrão: `1` · 1 – …
`pageSize`	consulta	number	padrão: `20` · 1 – 100
`filter`	consulta	string	`all` · `delivered` · `read` · `replied` · `failed` · `pending`

curl

curl "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/recipients?page=1&pageSize=20" \
  -H "Authorization: Bearer $WM_API_KEY"

Node.js

const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/recipients?page=1&pageSize=20', {
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
  },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/recipients?page=1&pageSize=20",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
data = r.json()

PHP

<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/recipients?page=1&pageSize=20');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
  ],
]);
$data = json_decode(curl_exec($ch), true);

Resposta 200

{
  "data": [
    {
      "id": "7c8d9e0f-1a2b-4c3d-8e4f-5a6b7c8d9e0f",
      "contact": {
        "id": "0b1c2d3e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
        "fullName": "Laura Pérez",
        "primaryPhone": "+34612345678"
      },
      "market": "ES",
      "status": "DELIVERED",
      "sentAt": "2026-10-10T08:00:02.000Z",
      "deliveredAt": "2026-10-10T08:00:05.000Z",
      "readAt": null,
      "failedAt": null,
      "errorMessage": null,
      "totalCost": 0.05,
      "coveredByAllowance": false
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 1200,
    "totalPages": 60
  }
}

Adicionar público

POST/campaigns/{id}/recipients

Uma de quatro fontes: lista de ids (contactIds, até 20.000), uma etapa (lifecycleStageId), uma etiqueta (tag) ou all: true para todos. Só entram os contatos com consentimento e telefone; a resposta diz quantos ficaram de fora e por quê, quantos entraram (added) e quantos já estavam (alreadyIn).

Permissões: campaigns:write

Parâmetros

Nome	Onde	Tipo	Valores
`id` obrigatório	rota	string

Corpo da requisição Audience

Nome	Tipo	Valores
`contactIds`	uuid[]	≤ 20000
`lifecycleStageId`	uuid
`all`	boolean
`tag`	string	0–60 caracteres

curl

curl -X POST "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/recipients" \
  -H "Authorization: Bearer $WM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "tag": "campaña-octubre"
}'

Node.js

const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/recipients', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "tag": "campaña-octubre"
  }),
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/recipients",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    json={
        "tag": "campaña-octubre"
    },
    timeout=30,
)
r.raise_for_status()
data = r.json()

PHP

<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/recipients');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => json_encode([
    'tag' => 'campaña-octubre'
  ]),
]);
$data = json_decode(curl_exec($ch), true);

Resposta 201

{
  "total": 1217,
  "optedOut": 14,
  "withoutPhone": 3,
  "unpriceable": 0,
  "eligible": 1200,
  "added": 1200,
  "alreadyIn": 0,
  "totalRecipients": 1200
}

Custo previsto

GET/campaigns/{id}/preview-cost

Antes de enviar: quantos destinatários são cobrados, o preço final por mensagem em cada mercado de destino (conforme o prefixo do número que recebe) e o total na moeda da sua organização. Os telefones sem prefixo válido não são enviados nem cobrados. wallet.sufficient diz se o saldo é suficiente; includedUtilityRemaining são as mensagens Utility incluídas que restam (apenas modelos Utility).

Permissões: campaigns:read

Parâmetros

Nome	Onde	Tipo	Valores
`id` obrigatório	rota	string

curl

curl "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/preview-cost" \
  -H "Authorization: Bearer $WM_API_KEY"

Node.js

const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/preview-cost', {
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
  },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/preview-cost",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
data = r.json()

PHP

<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/preview-cost');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
  ],
]);
$data = json_decode(curl_exec($ch), true);

Resposta 200

{
  "currency": "EUR",
  "recipientCount": 1200,
  "priceableCount": 1197,
  "unpriceableCount": 3,
  "estimatedTotal": 59.85,
  "byMarket": [
    {
      "market": "ES",
      "label": "España",
      "recipientCount": 1100,
      "totalCost": 0.05,
      "subtotal": 55,
      "rateEffectiveFrom": "2026-07-01"
    },
    {
      "market": "AR",
      "label": "Argentina",
      "recipientCount": 97,
      "totalCost": 0.05,
      "subtotal": 4.85,
      "rateEffectiveFrom": "2026-07-01"
    }
  ],
  "wallet": {
    "balance": 120,
    "afterSend": 60.15,
    "sufficient": true
  },
  "includedUtilityRemaining": null
}

Enviar, agendar ou escalonar

POST/campaigns/{id}/send

when: now (ou sem corpo) envia na hora; scheduled com scheduledAt (ISO 8601 com fuso, pelo menos um minuto no futuro) a deixa agendada; staggered a distribui em lotes de batchSize (10 a 5.000) a cada batchIntervalMin minutos (1 a 1.440). O custo do lote é debitado da wallet antes de chamar a Meta; se o saldo não for suficiente, responde 400 «Saldo insuficiente en la wallet.» e a campanha fica como estava. Responde com a campanha e seu novo status.

Permissões: campaigns:write

Parâmetros

Nome	Onde	Tipo	Valores
`id` obrigatório	rota	string

Corpo da requisição SendCampaign

Nome	Tipo	Valores
`when`	string	`now` · `scheduled` · `staggered`
`scheduledAt`	string
`batchSize`	number	10 – 5000
`batchIntervalMin`	number	1 – 1440

Erros frequentes

400 CAMPAIGN_VARIABLES_REQUIRED O modelo tem variáveis e a campanha não diz de onde elas saem.
400 «Saldo insuficiente en la wallet.»: recarregue pelo painel e envie de novo.
400 «La campaña ya fue enviada o está en un estado inválido.»: só são enviados rascunhos e agendadas.

curl

curl -X POST "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/send" \
  -H "Authorization: Bearer $WM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "when": "staggered",
  "batchSize": 200,
  "batchIntervalMin": 10
}'

Node.js

const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/send', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "when": "staggered",
    "batchSize": 200,
    "batchIntervalMin": 10
  }),
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/send",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    json={
        "when": "staggered",
        "batchSize": 200,
        "batchIntervalMin": 10
    },
    timeout=30,
)
r.raise_for_status()
data = r.json()

PHP

<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/send');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => json_encode([
    'when' => 'staggered',
    'batchSize' => 200,
    'batchIntervalMin' => 10
  ]),
]);
$data = json_decode(curl_exec($ch), true);

Resposta 201

{
  "id": "3a4b5c6d-7e8f-4a9b-8c0d-1e2f3a4b5c6d",
  "organizationId": "f0e1d2c3-b4a5-4968-8776-655443322110",
  "phoneNumberId": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
  "templateId": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
  "name": "Octubre: promo",
  "status": "DRAFT",
  "scheduledAt": null,
  "startedAt": null,
  "completedAt": null,
  "batchSize": null,
  "batchIntervalMin": null,
  "nextBatchAt": null,
  "pausedAt": null,
  "stopReason": null,
  "sourceCampaignId": null,
  "createdAt": "2026-10-09T16:00:00.000Z",
  "updatedAt": "2026-10-09T16:00:00.000Z",
  "template": {
    "id": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
    "name": "promo_octubre",
    "category": "MARKETING",
    "language": "es",
    "bodyText": "Hola {{1}}, este mes tienes un {{2}} de descuento.",
    "status": "APPROVED"
  },
  "phoneNumber": {
    "id": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
    "numberE164": "+34600000000",
    "displayName": "Clínica Sol",
    "qualityRating": "GREEN"
  },
  "estimatedCost": null,
  "realCost": 0,
  "stats": {
    "total": 0,
    "pending": 0,
    "sent": 0,
    "delivered": 0,
    "read": 0,
    "replied": 0,
    "failed": 0,
    "progressPct": 0
  },
  "errorsByReason": [],
  "lastReplies": []
}

Pausar

POST/campaigns/{id}/pause

Interrompe o envio do que falta; o que já foi enviado não pode ser retirado. Somente com campanhas que estão enviando.

Permissões: campaigns:write

Parâmetros

Nome	Onde	Tipo	Valores
`id` obrigatório	rota	string

curl

curl -X POST "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/pause" \
  -H "Authorization: Bearer $WM_API_KEY"

Node.js

const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/pause', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
  },
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/pause",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
data = r.json()

PHP

<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/pause');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
  ],
]);
$data = json_decode(curl_exec($ch), true);

Resposta 200

{
  "id": "3a4b5c6d-7e8f-4a9b-8c0d-1e2f3a4b5c6d",
  "organizationId": "f0e1d2c3-b4a5-4968-8776-655443322110",
  "phoneNumberId": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
  "templateId": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
  "name": "Octubre: promo",
  "status": "DRAFT",
  "scheduledAt": null,
  "startedAt": null,
  "completedAt": null,
  "batchSize": null,
  "batchIntervalMin": null,
  "nextBatchAt": null,
  "pausedAt": null,
  "stopReason": null,
  "sourceCampaignId": null,
  "createdAt": "2026-10-09T16:00:00.000Z",
  "updatedAt": "2026-10-09T16:00:00.000Z",
  "template": {
    "id": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
    "name": "promo_octubre",
    "category": "MARKETING",
    "language": "es",
    "bodyText": "Hola {{1}}, este mes tienes un {{2}} de descuento.",
    "status": "APPROVED"
  },
  "phoneNumber": {
    "id": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
    "numberE164": "+34600000000",
    "displayName": "Clínica Sol",
    "qualityRating": "GREEN"
  },
  "estimatedCost": null,
  "realCost": 0,
  "stats": {
    "total": 0,
    "pending": 0,
    "sent": 0,
    "delivered": 0,
    "read": 0,
    "replied": 0,
    "failed": 0,
    "progressPct": 0
  },
  "errorsByReason": [],
  "lastReplies": []
}

Retomar

POST/campaigns/{id}/resume

Continua uma campanha pausada de onde parou (também as que foram pausadas por falta de saldo, depois de recarregar a wallet).

Permissões: campaigns:write

Parâmetros

Nome	Onde	Tipo	Valores
`id` obrigatório	rota	string

curl

curl -X POST "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/resume" \
  -H "Authorization: Bearer $WM_API_KEY"

Node.js

const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/resume', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
  },
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/resume",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
data = r.json()

PHP

<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/campaigns/{id}/resume');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
  ],
]);
$data = json_decode(curl_exec($ch), true);

Resposta 200

{
  "id": "3a4b5c6d-7e8f-4a9b-8c0d-1e2f3a4b5c6d",
  "organizationId": "f0e1d2c3-b4a5-4968-8776-655443322110",
  "phoneNumberId": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
  "templateId": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
  "name": "Octubre: promo",
  "status": "DRAFT",
  "scheduledAt": null,
  "startedAt": null,
  "completedAt": null,
  "batchSize": null,
  "batchIntervalMin": null,
  "nextBatchAt": null,
  "pausedAt": null,
  "stopReason": null,
  "sourceCampaignId": null,
  "createdAt": "2026-10-09T16:00:00.000Z",
  "updatedAt": "2026-10-09T16:00:00.000Z",
  "template": {
    "id": "e6f7a8b9-c0d1-4e2f-8a3b-4c5d6e7f8a9b",
    "name": "promo_octubre",
    "category": "MARKETING",
    "language": "es",
    "bodyText": "Hola {{1}}, este mes tienes un {{2}} de descuento.",
    "status": "APPROVED"
  },
  "phoneNumber": {
    "id": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
    "numberE164": "+34600000000",
    "displayName": "Clínica Sol",
    "qualityRating": "GREEN"
  },
  "estimatedCost": null,
  "realCost": 0,
  "stats": {
    "total": 0,
    "pending": 0,
    "sent": 0,
    "delivered": 0,
    "read": 0,
    "replied": 0,
    "failed": 0,
    "progressPct": 0
  },
  "errorsByReason": [],
  "lastReplies": []
}