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 um campo no corpo JSON.
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 POST https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "api_key": <string> }'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
The key is written to Vault and never to the database. Connecting resets the connection to unverified — a new key behind an old "verified" badge is a connection claiming a proof it does not have.
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
api_key | string | Sim | — |
from_local_part | string | Não | — |
from_display_name | string | Não | — |
sending_domain | string | Não | — |
reply_to | string | Não | — |
org_id | string | Não | — |
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 · 422 · 503