Référence APICréer une collection
POST/v1/collections

Créer une collection

Crée une collection de transferts.

1 min de lectureTélécharger en PDF

Requête exemple

{
"name": "Ma Collection Importante",
"slug": "ma-collection",
"is_active": true,
"expires_at": "2026-12-31T23:59:59Z",
"cover_color": "#3B82F6",
"description": "Une collection de transferts",
"allow_download": true
}

Réponse exemple

{
"id": "col_def456uvw",
"name": "Ma Collection Importante",
"slug": "ma-collection",
"is_active": true,
"created_at": "2026-06-05T12:00:00Z",
"expires_at": "2026-12-31T23:59:59Z",
"updated_at": "2026-06-05T12:00:00Z",
"cover_color": "#3B82F6",
"description": "Une collection de transferts",
"allow_download": true,
"show_powered_by": true,
"watermark_enabled": false
}

Crée une collection dans le workspace. Une collection regroupe plusieurs transferts derrière une page unique, avec sections et personnalisation.

Authentification

Requiert une clé API avec le scope collections:manage.

Corps de la requête

ChampTypeRequisDescription
namestringOuiNom de la collection.
slugstringNonIdentifiant d'URL unique. Généré depuis le nom si absent.
descriptionstringNonDescription courte.
subtitlestringNonSous-titre.
logo_urlstringNonURL du logo.
cover_colorstringNonCouleur hex de couverture (ex. #3B82F6).
cover_image_urlstringNonURL de l'image de couverture.
is_activebooleanNonActive la collection (défaut true).
allow_downloadbooleanNonAutorise le téléchargement (défaut true).
watermark_enabledbooleanNonActive le watermark (défaut false).
expires_atstringNonDate d'expiration ISO 8601.

Codes de statut

  • 201 Collection créée.
  • 400 Validation (nom manquant).
  • 409 Slug déjà utilisé.
  • 403 Scope insuffisant.