ReferenceCampanhas
Consultar campanha
Retorna o status e o progresso de envio de uma campanha.
x-api-key<token>
Chave de API no formato sk_live_..., no header x-api-key.
In: header
Path Parameters
id_campaign*string
ID da campanha (formato campaign_<uuid>).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/external/info-campaign/string"{ "success": true, "id_campaign": "string", "name": "string", "status": "pending", "message_type": "string", "id_segment": "string", "segment_name": "string", "groups": { "total": 0, "sent": 0, "pending": 0, "failed": 0 }, "scheduled_at": "2019-08-24T14:15:22Z", "created_at": "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": "Not Found", "message": "Segmento não encontrado."}{ "success": false, "error": "Too Many Requests", "code": "rate_limited", "message": "Muitas requisições. Tente novamente em instantes."}{ "success": false, "error": "Internal Server Error", "message": "Erro interno ao processar a requisição."}