agency-board

POST `/v1/agency/boards/{boardId}/invites`

Mint a copy-paste link to this board.

Баталгаажуулалт

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Энэхүү төгсгөлийн цэг нь тодорхойлолтдоо тодорхой зөвшөөрлийг заагаагүй тул түлхүүрээрээ шаардагдах хамгийн бага эрхийг өгч, таамаглахаас илүүтэйгээр хариуг шалгана уу.

Энэ төгсгөл цэг нь ямар ч байгууллагын ID шаардахгүй. Таны түлхүүр аль хэдийн харьяалагдах байгууллагыг тодорхойлж байгаа бөгөөд хариу нь тухайн байгууллагын хүрээнд хязгаарлагдана.

Туршиж үзэх

Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.

curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/invites \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй API рүү хүсэлт илгээх тул та бодит хариуг харах боломжтой болно. Энэ төгсгөлийн цэгийг API консол дээр нээх

Дэлгэрэнгүй

Returns a link you can paste into anything — a chat, an email you write yourself, a document. **No email is sent by us**, which is the point. A `viewer` link is read-only and needs **no Zinn® account**: whoever opens it sees exactly what the client sees, and can write nothing. Any other role seats the person on the board and therefore requires them to sign in first. ⛔ `token` appears in **this response only**. It cannot be read back later. ⛔ For a seat-bearing role this refuses unless the caller could grant that seat's organisation role themselves. The check has to happen here rather than at redemption, because by then the person redeeming is a stranger and there is no principal whose privileges could bound the grant.

Параметрүүд

Нэр	Төрөл	Заавал шаардлагатай	Энэ юу вэ
`boardId (path)`	`Uuid`	Тийм	Project board ID (UUIDv7).

Хүсэлтийн бие

Нэр	Төрөл	Заавал шаардлагатай	Энэ юу вэ
`role`	`AgencyBoardInviteRole`	Үгүй	—
`label`	`string`	Үгүй	—
`expires_in_days`	`integer`	Үгүй	—
`max_uses`	`integer`	Үгүй	Omit for an unlimited link.

Хариу үйлдэл

Нэр	Төрөл	Заавал шаардлагатай	Энэ юу вэ
`id`	`Uuid`	Тийм	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Тийм	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`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…
`token`	`string`	Үгүй	The full link token. ⛔ Present on the create response and NOWHERE ELSE. Only its SHA-256 digest is stored, so nothing can re-derive it — a screen that needs it must keep it…
`token_prefix`	`string`	Тийм	The first few characters, so a manager with three links open can tell them apart. Far too short to shorten the search space of the secret part.
`label`	`string`	Үгүй	A note the manager typed. Never shown to the recipient.
`member_org_id`	`string`	Үгүй	The organisation a seat from this link belongs to. `null` for `viewer`, which seats nobody.
`expires_at`	`string`	Тийм	When the link stops admitting new people. ⛔ Expiry does not evict anybody who already joined — a colleague who joined in March must not lose the board in April because the s…
`max_uses`	`integer`	Үгүй	`null` is unlimited. `1` makes the link single-use.
`uses`	`integer`	Тийм	Seats created through this link. A repeat visit by somebody already on the board does not count, so a client who bookmarks the link cannot exhaust it.
`revoked_at`	`string`	Үгүй	—
`last_used_at`	`string`	Үгүй	—
`created_at`	`string`	Тийм	—
`is_live`	`boolean`	Тийм	Whether the link may admit somebody new right now — not revoked, not expired, not exhausted. Computed, so a caller never has to re-implement all three conditions.

Энэ төгсгөл цэгээс буцааж болох алдаанууд

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/invites