agency-board

POST `/v1/agency/boards/{boardId}/event-subscriptions`

Turn a platform event on for this board.

प्रमाणन

एक बीयर टोकन के रूप में एक API कुंजी भेजें। यह एंडपॉइंट विनिर्देश में किसी विशिष्ट अनुमति का उल्लेख नहीं करता है, इसलिए अपनी कुंजी को न्यूनतम आवश्यकता दें और अनुमान लगाने के बजाय प्रतिक्रिया की जाँच करें।

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/event-subscriptions \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "event_type": <string>, "column_id": <Uuid> }'

साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें

विवरण

Opt-in, per board, off by default — nothing appears on a board nobody chose. One subscription per event type per board; posting the same event type again updates it. Cards land `internal` unless you say otherwise: a platform event names our own infrastructure and sometimes our own failures, and putting one in front of the agency's client should be a choice rather than a default.

पैरामीटर

नाम	प्रकार	आवश्यक	यह क्या है
`boardId (path)`	`Uuid`	हाँ	Project board ID (UUIDv7).

अनुरोध बॉडी

नाम	प्रकार	आवश्यक	यह क्या है
`event_type`	`string`	हाँ	—
`column_id`	`Uuid`	हाँ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`label_id`	`Uuid`	नहीं	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_visibility`	`string<internal, client>`	नहीं	—
`enabled`	`boolean`	नहीं	—

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यह क्या है
`id`	`Uuid`	हाँ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	हाँ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`event_type`	`string`	हाँ	—
`column_id`	`Uuid`	हाँ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`label_id`	`Uuid`	नहीं	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_visibility`	`string<internal, client>`	नहीं	—
`enabled`	`boolean`	हाँ	—
`card_count`	`integer`	नहीं	—
`last_card_at`	`string`	नहीं	—
`created_at`	`string`	नहीं	—

त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/event-subscriptions