campaigns

PATCH `/v1/campaigns/segments/{segmentId}`

Rename a segment or change its filters.

احراز هویت

یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمی‌کند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.

جایی که شناسه سازمان شما قرار می‌گیرد

این نقطه پایانی org_id را به عنوان یک پارامتر پرس‌وجو می‌پذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجاره‌ای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.

شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواست‌هایی که ارسال می‌کنید یکسان است.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X PATCH https://api.zinndigital.com/v1/campaigns/segments/{segmentId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "definition": <CampaignSegmentNode> }'

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

`scope` is absent from the body and cannot be changed: a segment reviewed and approved as "my clients" must not silently become "the estate".

پارامترها

نام	نوع	الزامی	چیست
`segmentId (path)`	`string`	بله	—
`org_id (query)`	`string`	خیر	—

بدنه درخواست

نام	نوع	الزامی	چیست
`name`	`string`	بله	—
`description`	`string`	خیر	—
`definition`	`CampaignSegmentNode`	بله	A 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…

پاسخ

نام	نوع	الزامی	چیست
`id`	`string`	بله	—
`org_id`	`string`	بله	The segment's OWNER, not the orgs it selects.
`scope`	`string<platform, reseller>`	بله	—
`name`	`string`	بله	—
`description`	`string`	خیر	—
`definition`	`CampaignSegmentNode`	بله	A 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…
`status`	`string<active, archived>`	بله	—
`created_by`	`string`	خیر	—
`created_at`	`string`	خیر	—
`updated_at`	`string`	خیر	—

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 422

PATCH /v1/campaigns/segments/{segmentId}