public

POST `/v1/public/boards/shared/{shareToken}/join`

Take the seat a share link grants you.

توثيقِ شناخت

ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

curl -X POST https://api.zinndigital.com/v1/public/boards/shared/{shareToken}/join \
  -H "Authorization: Bearer zdk_live_…"

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

Requires a signed-in person — this is the *"one screen from the invite, with the board waiting on the other side"* half of the flow. A `viewer` link needs no join and says so rather than refusing, because a UI offering **Join** on a read-only link is a UI bug and the honest answer costs one field. Idempotent: somebody already on the board gets their existing seat back and it does **not** consume one of the link's uses. A client who bookmarks the link and opens it every Monday must not exhaust a 5-use link by themselves.

پیرامیٹرز

نام	قسم	لازمی	یہ کیا ہے
`shareToken (path)`	`string`	ہاں	The share link's bearer token, as it appears in the URL somebody pasted. This is a credential: 256 bits from a CSPRNG behind a `zbi_` prefix, and whoever holds it holds the…

جواب

نام	قسم	لازمی	یہ کیا ہے
`joined`	`boolean`	ہاں	—
`seated`	`boolean`	نہیں	Whether this call created the seat, as opposed to returning an existing one.
`role`	`AgencyBoardInviteRole`	نہیں	What a share link grants. `viewer` is link-only: it creates no board seat and no organisation membership, because it grants no identity — it is read-through-the-token, which…
`board_id`	`Uuid`	ہاں	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`membership_id`	`string`	نہیں	—
`detail`	`string`	نہیں	—

وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے

401 · 404 · 410 · 422

POST /v1/public/boards/shared/{shareToken}/join