Campaigns
GET /v1/campaigns/esp
The organisation's own e-mail provider account.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
Never returns the API key or its Vault path — only the state of the connection and its lifetime delivery counters.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
org_id (query) | Uuid | Não | The organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen… |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
connected | boolean | Sim | — |
id | string | Não | — |
provider | string | Sim | — |
status | string<not_connected, unverified, verified, rejected> | Sim | — |
from_address | string | Não | — |
from_local_part | string | Não | — |
from_display_name | string | Não | — |
sending_domain | string | Não | — |
reply_to | string | Não | — |
verified_domains | EspVerifiedDomain[] | Não | — |
last_verified_at | string | Não | — |
last_error | string | Não | — |
stats | CampaignDeliveryCounts | Não | ⛔ `sent` is NOT `delivered`. `sent` means a provider accepted the hand-off; `delivered` means the receiving server accepted it, which arrives later by webhook. A screen showing… |
Erros que este endpoint pode retornar
401 · 403