Campaigns
DELETE /v1/campaigns/esp
Disconnect the provider account and remove its stored key.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树;发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X DELETE https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Forget this organisation's e-mail provider. The stored key is removed from Vault, not merely hidden — and campaigns refuse to send until a provider is connected again.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
org_id (query) | Uuid | 否 | 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… |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
connected | boolean | 是 | — |
id | string | 否 | — |
provider | string | 是 | — |
status | string<not_connected, unverified, verified, rejected> | 是 | — |
from_address | string | 否 | — |
from_local_part | string | 否 | — |
from_display_name | string | 否 | — |
sending_domain | string | 否 | — |
reply_to | string | 否 | — |
verified_domains | EspVerifiedDomain[] | 否 | — |
last_verified_at | string | 否 | — |
last_error | string | 否 | — |
stats | CampaignDeliveryCounts | 否 | ⛔ `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… |
此端点可能返回的错误
401 · 403