אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כשדה בגוף ה-JSON.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X POST https://api.zinndigital.com/v1/agency/boards \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
Creates the board and a working default pipeline — Requests · Backlog · In progress · Review · Done — with Requests marked as the client intake column and Requests, In progress and Done already client-visible. ⛔ Not a placeholder (§2.41): the board is usable by an agency and by its client the moment it exists, rather than after a configuration step nobody documents. Requires the agency_project_board entitlement on the acting org.
גוף הבקשה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
name | string | כן | — |
description | string | לא | — |
org_id | string | לא | — |
client_org_id | string | לא | — |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
id | Uuid | כן | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | כן | The agency that owns this board. |
client_org_id | string | לא | The client organisation this board's work is for, if any. This is what authorises a client's read — never the org tree, because "is a descendant of the agency" is a weaker claim… |
client_org_name | string | לא | That client organisation's name, resolved by the engine. client_org_id set with this null is a real state and not an error — the board names a client the caller may not read —… |
name | string | כן | — |
description | string | לא | — |
archived_at | string | לא | — |
open_question_count | integer | לא | — |
created_at | string | כן | — |
updated_at | string | לא | — |
created_by | AgencyBoardActor | לא | Who created the board. null if that account no longer exists. |
updated_by | AgencyBoardActor | לא | Who last changed the board itself — its name, description or client organisation. ⛔ NOT "who last touched anything on it": that is the activity feed. It moves exactly when… |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 422