Référence APIRetirer un élément d'une collection
DELETE/v1/collections/{id}/items/{itemId}

Retirer un élément d'une collection

Retire définitivement un élément d'une collection appartenant à votre espace de travail.

1 min de lectureTélécharger en PDF

Réponse exemple

{
"id": "item_8f3a2c1d",
"object": "collection_item",
"deleted": true
}
DELETE/v1/collections/{id}/items/{itemId}Retire l'élément {itemId} de la collection {id}.

Cet endpoint retire un élément précis d'une collection. La collection est d'abord résolue via le workspace authentifié : seul un élément appartenant à une collection de votre espace de travail peut être supprimé. L'opération est définitive et ne supprime que le lien d'appartenance (coffrify_collection_items), pas la ressource sous-jacente référencée par l'élément. La réponse confirme la suppression avec un accusé minimal.

Authentification

Cette requête exige une clé API valide portant le scope collections:manage. Les scopes plus larges sont acceptés via la hiérarchie d'alias : un token collections:* ou * (accès complet) satisfait également l'exigence. Transmettez la clé dans l'en-tête Authorization: Bearer cof_live_....

Paramètres de chemin

ChampTypeRequisDescription
idstringOuiIdentifiant de la collection parente. Doit appartenir au workspace authentifié.
itemIdstringOuiIdentifiant de l'élément à retirer de la collection.

Aucun corps de requête n'est lu pour cette méthode : les segments id et itemId sont extraits directement du chemin de l'URL.

Réponse

En cas de succès (200), la réponse renvoie un objet de confirmation : `id` reprend l'identifiant de l'élément supprimé, `object` vaut toujours collection_item, et `deleted` vaut true. Les en-têtes incluent X-Request-Id, X-Coffrify-Api-Version ainsi que les en-têtes de quota X-RateLimit-*.

Erreurs

CodeQuandRésolution
401 invalid_api_key / missing_api_keyClé API absente, mal préfixée, révoquée ou expirée.Fournissez une clé valide commençant par cof_live_ ou cof_test_ dans l'en-tête Authorization.
403 scope_missingLe token ne porte pas le scope collections:manage (ni alias couvrant).Émettez une nouvelle clé avec le scope collections:manage depuis app.coffrify.com/developer.
404 not_foundLa collection n'existe pas dans ce workspace, ou l'élément n'est pas présent dans la collection.Vérifiez que id appartient à votre workspace et que itemId fait bien partie de cette collection.
429 rate_limitedQuota par minute du workspace dépassé sur les endpoints d'écriture.Respectez l'en-tête Retry-After avant de réessayer.
500 internal_errorÉchec inattendu côté base de données lors de la suppression.Réessayez ; si l'erreur persiste, contactez le support avec le request_id retourné.

Voir aussi