Référence APIModifier une section de collection
PATCH/v1/collections/{id}/sections

Modifier une section de collection

Met à jour partiellement une section identifiée par son id dans le corps de la requête.

1 min de lectureTélécharger en PDF

Requête exemple

{
"id": "sec_9Lp4rT1xYwQ7",
"name": "Documents juridiques (révisés)",
"position": 30,
"is_visible": false
}

Réponse exemple

{
"id": "sec_9Lp4rT1xYwQ7",
"name": "Documents juridiques (révisés)",
"position": 30,
"created_at": "2026-06-05T10:42:18.553Z",
"is_visible": false,
"description": "Statuts, pactes et baux"
}
PATCH/v1/collections/{id}/sectionsMet à jour une section ciblée par l'`id` transmis dans le corps.

Met à jour partiellement une section. Particularité : la section visée n'est pas indiquée dans l'URL mais par le champ id du corps de la requête. Seuls les champs reconnus et fournis sont modifiés ; si aucun champ valide n'est présent, une erreur 400 validation_error est renvoyée. La section doit appartenir à la collection {id} (elle-même vérifiée comme vôtre) sinon 404 not_found.

Authentification

Cette requête exige une clé API valide disposant du scope transfers:write. Transmettez la clé via Authorization: Bearer cof_live_.... Une clé sans ce scope reçoit 403 scope_missing.

Corps de la requête

ChampTypeRequisDescription
idstringOuiIdentifiant de la section à modifier. Absent ou non-chaîne : 400 validation_error.
namestringNonNouveau nom (espaces de bord supprimés). Appliqué seulement si chaîne.
descriptionstring | nullNonNouvelle description. Accepte explicitement null pour effacer la valeur.
positionnumberNonNouvelle position (arrondie à l'entier inférieur). Appliquée seulement si numérique.
is_visiblebooleanNonNouvelle visibilité. Appliquée seulement si booléenne.

Au moins un champ modifiable (name, description, position ou is_visible) doit être présent en plus de id, faute de quoi la requête échoue avec 400 validation_error (« No valid fields to update »).

Réponse

Renvoie la section après mise à jour, avec id, name, description, position, is_visible et created_at. Le statut HTTP de succès est 200.

ChampTypeDescription
idstringIdentifiant de la section.
namestringNom après mise à jour.
descriptionstring | nullDescription après mise à jour.
positionnumberPosition après mise à jour.
is_visiblebooleanVisibilité après mise à jour.
created_atstring (ISO 8601)Date de création (inchangée).

Erreurs

CodeQuandRésolution
400 validation_errorid manquant, ou aucun champ modifiable fourni.Fournissez id plus au moins un champ valide.
401 missing_api_keyEn-tête Authorization absent.Ajoutez Authorization: Bearer cof_live_....
401 invalid_api_keyClé invalide ou préfixe non reconnu.Vérifiez la clé.
403 scope_missingLa clé n'a pas le scope transfers:write.Émettez une clé incluant transfers:write.
404 not_foundCollection inexistante, hors de votre espace, ou section introuvable dans cette collection.Vérifiez l'id de la collection et celui de la section.
429 rate_limitedQuota de requêtes par minute dépassé.Patientez selon l'en-tête Retry-After.
500 internal_errorErreur de mise à jour en base.Réessayez ; conservez le request_id.

Voir aussi