Référence APISupprimer une section de collection
DELETE/v1/collections/{id}/sections

Supprimer une section de collection

Supprime une section et orpheline ses éléments (section_id remis à null) au lieu de les supprimer.

1 min de lectureTélécharger en PDF

Réponse exemple

{
"id": "sec_9Lp4rT1xYwQ7",
"object": "collection_section",
"deleted": true
}
DELETE/v1/collections/{id}/sectionsSupprime une section et détache ses éléments.

Supprime une section de la collection {id}. Comportement notable et non destructif pour le contenu : les éléments rattachés à la section ne sont pas supprimés mais orphelinés, c'est-à-dire que leur section_id est remis à null (ils restent dans la collection, sans section). La section visée est désignée par le champ id du corps de la requête. La collection est vérifiée comme vôtre avant l'opération.

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 à supprimer. Absent ou non-chaîne : 400 validation_error.

Réponse

Renvoie un accusé de suppression : id (l'identifiant de la section supprimée), object valant "collection_section" et deleted valant true. Le statut HTTP de succès est 200.

ChampTypeDescription
idstringIdentifiant de la section supprimée.
objectstringToujours "collection_section".
deletedbooleanToujours true en cas de succès.

Erreurs

CodeQuandRésolution
400 validation_errorid de section absent ou non-chaîne.Transmettez { "id": "sec_..." } dans le corps.
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 les identifiants de collection et de section.
429 rate_limitedQuota de requêtes par minute dépassé.Patientez selon l'en-tête Retry-After.
500 internal_errorErreur de suppression en base.Réessayez ; conservez le request_id.

Voir aussi