Référence APIMettre à jour une section d'un coffre
PATCH/v1/coffres/{id}/sections

Mettre à jour une section d'un coffre

Modifie le titre, la description, la visibilité ou la position d'une section existante, identifiée par section_id dans le corps.

1 min de lectureTélécharger en PDF

Requête exemple

{
"title": "États financiers consolidés",
"position": 2,
"is_visible": false,
"section_id": "sec_a71b9d02"
}

Réponse exemple

{
"id": "sec_a71b9d02",
"title": "États financiers consolidés",
"position": 2,
"coffre_id": "cof_3b9d7e21",
"created_at": "2026-05-20T09:16:48.000Z",
"is_visible": false,
"description": "Bilans et comptes de résultat des 3 derniers exercices"
}
PATCH/v1/coffres/{id}/sectionsMet à jour une section du coffre {id}, ciblée par section_id dans le corps.

Met à jour une section existante du coffre {id}. La section cible est désignée par section_id dans le corps de la requête (et non dans l'URL). Comportement notable : la mise à jour est partielle, seuls les champs fournis et valides sont modifiés ; si le corps ne contient aucun champ modifiable valide, l'appel échoue avec 400 validation_error. L'appartenance de la section au couple coffre/workspace est vérifiée avant toute écriture.

Authentification

Cet endpoint exige une clé API valide portant le scope transfers:write. Un jeton sans ce scope reçoit une erreur 403 scope_missing. Comme toute opération d'écriture, l'appel passe par le mécanisme d'idempotence (Idempotency-Key).

Corps de la requête

ChampTypeRequisDescription
section_idstringOuiIdentifiant de la section à modifier. Absent : 400 validation_error. Inconnu pour ce coffre/workspace : 404 not_found.
titlestringNonNouvel intitulé (espaces de début/fin retirés). Pris en compte uniquement si c'est une chaîne.
descriptionstringNonNouvelle description (espaces retirés ; une valeur vide devient null).
is_visiblebooleanNonNouvelle visibilité. Pris en compte uniquement si c'est un booléen.
positionnumberNonNouveau rang d'affichage. Pris en compte uniquement si c'est un nombre.

Réponse

Renvoie 200 OK avec l'objet section à jour : id, coffre_id, title, description, position, is_visible et created_at. Les champs non transmis conservent leur valeur antérieure.

ChampTypeDescription
idstringIdentifiant de la section.
coffre_idstringIdentifiant du coffre parent.
titlestringIntitulé après mise à jour.
descriptionstring | nullDescription après mise à jour, ou null.
positionintegerRang d'affichage après mise à jour.
is_visiblebooleanVisibilité après mise à jour.
created_atstringDate de création initiale (inchangée).

Erreurs

CodeQuandRésolution
400 validation_errorCoffre manquant, corps non-JSON, section_id absent, ou aucun champ modifiable valide fourni.Envoyez section_id et au moins un champ valide (title, description, is_visible ou position).
401 invalid_api_keyClé API absente, mal formée ou non reconnue.Fournissez une clé valide dans l'en-tête Authorization.
403 scope_missingLe jeton ne porte pas le scope transfers:write.Émettez une clé incluant transfers:write.
404 not_foundLa section n'existe pas pour ce coffre/workspace.Vérifiez section_id ainsi que l'identifiant du coffre.
429 rate_limitedQuota de requêtes par minute dépassé.Respectez l'en-tête Retry-After puis réessayez.
500 internal_errorÉchec de la mise à jour en base.Réessayez ; en cas de persistance, contactez le support avec le request_id.

Voir aussi