OrbitSenderDocs
ReferenceCampanhas

Criar campanha de enquete

POST
/api/external/create-campaign/poll

Cria uma campanha de enquete (poll) com 2 a 12 opções.

Authorization

ApiKeyAuth
api-key<token>

Chave de API no formato sk_live_....

In: header

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

curl -X POST "https://example.com/api/external/create-campaign/poll" \  -H "Content-Type: application/json" \  -d '{    "name": "Pesquisa de produto",    "id_segment": "segment_xxx",    "poll_data": {      "message": "Qual produto você prefere?",      "options": [        "Opção A",        "Opção B",        "Opção C"      ],      "pollOptions": "single"    }  }'
{  "success": true,  "id_campaign": "string",  "name": "string",  "status": "pending",  "message_type": "poll",  "poll_type": "single",  "options_count": 0,  "scheduled_at": "2019-08-24T14:15:22Z",  "timestamp": "2019-08-24T14:15:22Z"}
{  "success": false,  "error": "Bad Request",  "message": "O campo \"name\" é obrigatório no body da requisição."}
{  "success": false,  "error": "Unauthorized",  "message": "Chave de API inválida ou ausente."}
{  "success": false,  "error": "Forbidden",  "message": "Limite de canais atingido.",  "current": 5,  "max": 5}
{  "success": false,  "error": "Not Found",  "message": "Segmento não encontrado."}
{  "success": false,  "error": "Internal Server Error",  "message": "Erro interno ao processar a requisição."}