PEPINO ZAPdocs
Referência da APICampanhas

Adiciona destinatarios

Ver como Markdown
POST
/v1/campaigns/{id}/recipients

Acrescenta destinatarios a uma campanha (DRAFT, SCHEDULED, RUNNING ou PAUSED — 409 se ja encerrada). Mesmo formato do create (string ou objeto). Respeita o limite de 10.000 no total. Numa campanha RUNNING os novos entram na fila e seguem a cadencia. Exige o add-on.

Authorization

bearerAuth
AuthorizationBearer <token>

API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...

In: header

Path Parameters

id*string

Identificador da campanha.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/campaigns/string/recipients" \  -H "Content-Type: application/json" \  -d '{    "recipients": [      {        "phone": "5511999990010",        "name": "Joao"      },      "5511999990011"    ]  }'
{
  "added": 0
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Body invalido"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key ausente ou invalida"
  }
}
{
  "error": {
    "code": "PAYMENT_REQUIRED",
    "message": "E necessario um plano ativo para usar este recurso. Assine em \"Meu plano\"."
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Projeto inativo ou sem permissao"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Instancia nao encontrada"
  }
}
{
  "error": {
    "code": "CONFLICT",
    "message": "limite de numeros do plano atingido — adicione um numero em \"Meu plano\""
  }
}