Référence APICréer une section dans une collection
POST/v1/collections/{id}/sections

Créer une section dans une collection

Crée une nouvelle section dans une collection, avec auto-positionnement en fin de liste.

1 min de lectureTélécharger en PDF

Requête exemple

{
"name": "Documents juridiques",
"position": 20,
"is_visible": true,
"description": "Statuts, pactes et baux"
}

Réponse exemple

{
"id": "sec_9Lp4rT1xYwQ7",
"name": "Documents juridiques",
"position": 20,
"created_at": "2026-06-05T10:42:18.553Z",
"is_visible": true,
"description": "Statuts, pactes et baux"
}
POST/v1/collections/{id}/sectionsCrée une section dans la collection désignée.

Crée une nouvelle section dans la collection {id}. Comportement notable : si position n'est pas fournie, la section est auto-positionnée en fin de liste (la dernière position connue + 10, ou 0 si la collection ne contient encore aucune section). La collection est vérifiée comme vôtre avant insertion. En cas de succès, la réponse est renvoyée avec le statut HTTP 201.

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
namestringOuiNom de la section. Espaces de bord supprimés ; une valeur vide après nettoyage déclenche 400 validation_error.
descriptionstring | nullNonDescription de la section. Valeur non-chaîne ignorée (stockée null).
positionnumberNonPosition d'affichage (arrondie à l'entier inférieur). Si absente, auto-calculée en fin de liste (dernière position + 10).
is_visiblebooleanNonVisibilité de la section. Par défaut true si non fournie ou non booléenne.

Réponse

Renvoie la section créée avec son id généré, ainsi que name, description, position (effective, auto-calculée si non transmise), is_visible et created_at. Le statut HTTP de succès est 201.

ChampTypeDescription
idstringIdentifiant unique de la section créée.
namestringNom enregistré.
descriptionstring | nullDescription enregistrée.
positionnumberPosition effective (auto-calculée si omise).
is_visiblebooleanVisibilité enregistrée.
created_atstring (ISO 8601)Date de création.

Erreurs

CodeQuandRésolution
400 validation_errorname absent ou vide après suppression des espaces.Fournissez un name non vide.
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 ou hors de votre espace de travail.Vérifiez l'id de la collection.
429 rate_limitedQuota de requêtes par minute dépassé.Patientez selon l'en-tête Retry-After.
500 internal_errorErreur d'insertion en base.Réessayez ; conservez le request_id.

Voir aussi