Référence APISupprimer une section d'un coffre
DELETE/v1/coffres/{id}/sections

Supprimer une section d'un coffre

Supprime une section et détache ses éléments en les rendant orphelins plutôt que de les supprimer.

1 min de lectureTélécharger en PDF

Requête exemple

{
"section_id": "sec_a71b9d02"
}

Réponse exemple

{
"id": "sec_a71b9d02",
"object": "coffre_section",
"deleted": true
}
DELETE/v1/coffres/{id}/sectionsSupprime une section du coffre {id}, ciblée par section_id dans le corps.

Supprime une section du coffre {id}. La section cible est désignée par section_id dans le corps de la requête. Comportement notable : les éléments (items) rattachés à la section ne sont pas supprimés. Ils sont d'abord détachés en passant leur section_id à null, devenant ainsi des éléments orphelins du coffre, avant que la section elle-même ne soit effacée. La suppression est restreinte au couple coffre/workspace de la clé API.

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.

Corps de la requête

ChampTypeRequisDescription
section_idstringOuiIdentifiant de la section à supprimer. Absent : 400 validation_error. Inconnu pour ce coffre/workspace : 404 not_found.

Réponse

Renvoie 200 OK avec un accusé de suppression : id (l'identifiant de la section supprimée), object valant "coffre_section", et deleted à true.

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

Erreurs

CodeQuandRésolution
400 validation_errorIdentifiant de coffre manquant, ou section_id absent du corps.Transmettez un section_id dans le corps JSON et un {id} de coffre valide dans l'URL.
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 et 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 suppression en base.Réessayez ; en cas de persistance, contactez le support avec le request_id.

Voir aussi