agency-board

PATCH `/v1/agency/boards/{boardId}/cards/{cardId}/checklist/{itemId}`

Tick or un-tick one checklist item.

ਪ੍ਰਮਾਣੀਕਰਨ

ਇੱਕ API ਕੁੰਜੀ ਨੂੰ ਬੀਅਰ ਟੋਕਨ ਵਜੋਂ ਭੇਜੋ। ਇਹ ਐਂਡਪੁਆਇੰਟ ਸਪੈਸੀਫਿਕੇਸ਼ਨ ਵਿੱਚ ਕਿਸੇ ਖਾਸ ਇਜਾਜ਼ਤ ਨੂੰ ਨਹੀਂ ਦਰਸਾਉਂਦਾ, ਇਸ ਲਈ ਆਪਣੀ ਕੁੰਜੀ ਨੂੰ ਘੱਟੋ-ਘੱਟ ਲੋੜੀਂਦੀਆਂ ਇਜਾਜ਼ਤਾਂ ਦਿਓ ਅਤੇ ਮੰਨਣ ਦੀ ਬਜਾਏ ਜਵਾਬ ਦੀ ਜਾਂਚ ਕਰੋ।

ਇਹ ਐਂਡਪੁਆਇੰਟ ਕੋਈ ਸੰਸਥਾ ਆਈਡੀ ਨਹੀਂ ਲੈਂਦਾ। ਤੁਹਾਡੀ ਕੁੰਜੀ ਪਹਿਲਾਂ ਹੀ ਉਸ ਸੰਸਥਾ ਦੀ ਪਛਾਣ ਕਰਦੀ ਹੈ ਜਿਸ ਨਾਲ ਇਹ ਸਬੰਧਤ ਹੈ, ਅਤੇ ਜਵਾਬ ਉਸੇ ਤੱਕ ਸੀਮਤ ਹੈ।

ਕੋਸ਼ਿਸ਼ ਕਰੋ

ਕੋਈ ਵੀ ਚੀਜ਼ ਜੋ ਕੋਣ ਵਾਲੇ ਬਰੈਕਟਾਂ ਵਿੱਚ ਹੈ ਉਸਨੂੰ ਆਪਣੇ ਖੁਦ ਦੇ ਮੁੱਲਾਂ ਨਾਲ ਬਦਲੋ, ਅਤੇ ਕੁੰਜੀ ਪਲੇਸਹੋਲਡਰ ਨੂੰ ਆਪਣੇ ਡੈਸ਼ਬੋਰਡ ਦੀ ਇੱਕ ਕੁੰਜੀ ਨਾਲ ਬਦਲੋ।

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/cards/{cardId}/checklist/{itemId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "done": <boolean> }'

ਲੌਗ ਇਨ ਕੀਤਾ ਹੋਇਆ ਹੈ? ਤੁਹਾਡੇ ਡੈਸ਼ਬੋਰਡ ਵਿੱਚ API ਕੰਸੋਲ ਤੁਹਾਡੀ ਅਸਲ ਸੰਸਥਾ ਆਈਡੀ (organisation id) ਅਤੇ ਤੁਹਾਡੀ ਆਪਣੀ ਕੁੰਜੀ ਨੂੰ ਭਰਦਾ ਹੈ, ਅਤੇ ਲਾਈਵ API ਦੇ ਵਿਰੁੱਧ ਬੇਨਤੀ ਚਲਾਉਂਦਾ ਹੈ ਤਾਂ ਜੋ ਤੁਸੀਂ ਅਸਲ ਜਵਾਬ ਦੇਖ ਸਕੋ। API ਕੰਸੋਲ ਵਿੱਚ ਇਸ ਐਂਡਪੁਆਇੰਟ ਨੂੰ ਖੋਲ੍ਹੋ

ਵੇਰਵੇ

⛔ Idempotent, and it records nothing on the board's timeline when the state already matches. A checkbox re-sending its state would otherwise read as "ticked Deploy, 6 times" for one tick. ⭐ `done_by` is kept when an item is un-ticked. "Who ticked this and then un-ticked it" is a question an agency gets asked by its client, and clearing the field makes it unanswerable while looking tidier.

ਪੈਰਾਮੀਟਰ

ਨਾਮ	ਕਿਸਮ	ਲਾਜ਼ਮੀ	ਕੀ ਹੈ ਇਹ
`boardId (path)`	`Uuid`	ਹਾਂ	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	ਹਾਂ	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	ਹਾਂ	Board checklist item ID (UUIDv7).

ਬੇਨਤੀ ਬਾਡੀ

ਨਾਮ	ਕਿਸਮ	ਲਾਜ਼ਮੀ	ਕੀ ਹੈ ਇਹ
`done`	`boolean`	ਹਾਂ	—

ਜਵਾਬ

ਨਾਮ	ਕਿਸਮ	ਲਾਜ਼ਮੀ	ਕੀ ਹੈ ਇਹ
`id`	`Uuid`	ਹਾਂ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	ਹਾਂ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`text`	`string`	ਹਾਂ	—
`position`	`integer`	ਹਾਂ	—
`done_at`	`string`	ਨਹੀਂ	When it was ticked. `null` means outstanding.
`done_by`	`AgencyBoardActor`	ਨਹੀਂ	Who ticked it. ⛔ Kept when the item is un-ticked as well, so "Sam ticked this and then un-ticked it" stays answerable.
`created_at`	`string`	ਨਹੀਂ	—

ਇਹ ਐਂਡਪੁਆਇੰਟ ਜੋ ਗਲਤੀਆਂ ਵਾਪਸ ਕਰ ਸਕਦਾ ਹੈ

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}/cards/{cardId}/checklist/{itemId}