campaigns

DELETE /v1/campaigns/segments/{segmentId}

Archive a segment.

所有 campaigns 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。

您的组织 ID 应填在此处

此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树;发送该参数则将调用范围缩小到一个组织。

您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X DELETE https://api.zinndigital.com/v1/campaigns/segments/{segmentId} \
  -H "Authorization: Bearer zdk_live_…"

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

Hidden from the picker and kept. See `GET` above for why nothing here is deleted.

参数

名称类型必填内容简介
segmentId (path)string
org_id (query)string

响应

名称类型必填内容简介
idstring
org_idstringThe segment's OWNER, not the orgs it selects.
scopestring<platform, reseller>
namestring
descriptionstring
definitionCampaignSegmentNodeA filter tree. Two node shapes and no third: a GROUP (`op` with `children`) or a CONDITION (`field`/`operator`/`value`). `not` takes exactly one child — an n-ary `not` reads as…
statusstring<active, archived>
created_bystring
created_atstring
updated_atstring

此端点可能返回的错误

401 · 403 · 404