agency-board
PATCH /v1/agency/boards/{boardId}
Rename a board or attach a client organisation to it.
Autenticación
Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
Attaching a client to a board that has none is always allowed — that is how a board created for internal work becomes a client's board. ⛔ **Changing or clearing a client that is already attached is refused with a `422` once the client has seen anything on the board** — a client-visible card, a question asked of them, or one of their people invited to it. Re-pointing such a board would hand a second client the first one's brief, answers and complaints through a screen whose whole promise is that a client sees only what the agency shared. Archive the board and start a new one for the other client. Sending the client id the board already holds is not a change and is never refused, so a rename carrying the whole form still works.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
boardId (path) | Uuid | Sí | Project board ID (UUIDv7). |
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
name | string | No | — |
description | string | No | — |
client_org_id | string | No | — |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Sí | The agency that owns this board. |
client_org_id | string | No | 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 | No | 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 | Sí | — |
description | string | No | — |
archived_at | string | No | — |
open_question_count | integer | No | — |
created_at | string | Sí | — |
updated_at | string | No | — |
created_by | AgencyBoardActor | No | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | No | 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 `upda… |
Errores que este endpoint puede devolver
401 · 403 · 404 · 422