Mettre à jour un intake

Modifie les champs configurables d'un point de réception existant et renvoie la ressource mise à jour.

Requête exemple

{
  "allowed_origins": [
    "https://cabinet.exemple.fr",
    "https://staging.cabinet.exemple.fr"
  ],
  "reference_required": false
}

Réponse exemple

{
  "id": "int_4f2a9c1b",
  "name": "Dépôt KYC clients 2026",
  "object": "intake",
  "enabled": true,
  "updated_at": "2026-06-11T14:30:00Z",
  "allowed_origins": [
    "https://cabinet.exemple.fr",
    "https://staging.cabinet.exemple.fr"
  ],
  "metadata_policy": "strip",
  "reference_required": false
}

Cet endpoint vous permet de modifier la configuration d'un intake existant sans avoir à le recréer. Vous l'utilisez pour ajuster les origines autorisées lorsque vous déployez votre formulaire sur un nouveau sous-domaine, durcir la politique sur les métadonnées, exiger une référence client à chaque dépôt, ou désactiver temporairement le point de réception sans le supprimer. Les champs non fournis dans la requête restent inchangés. La clé publishable et l'identifiant de l'intake ne sont jamais modifiables et conservent leurs valeurs initiales.

PATCH/v1/intakes/{id}Met à jour partiellement un intake existant.

L'identifiant de l'intake est passé dans le chemin de l'URL. Vous obtenez cet identifiant lors de la création (POST /v1/intakes) ou en parcourant la liste (GET /v1/intakes). Toute requête doit présenter une clé serveur (cof_live_, cof_test_ ou cof_sandbox_) disposant du scope intake_write.

Authentification et scopes

L'appel s'effectue côté serveur avec une clé secrète envoyée dans l'en-tête Authorization au format Bearer. Le scope intake_write est requis. Les clés publishable cip_ utilisées dans le navigateur ne peuvent pas appeler cet endpoint : elles servent exclusivement au dépôt depuis le widget. Pensez à attacher un en-tête Idempotency-Key (entre 8 et 255 caractères) si vous rejouez vos écritures depuis un système de file d'attente.

Paramètres

Tous les paramètres du corps sont optionnels. Vous n'envoyez que les champs que vous souhaitez modifier. Pour vider la liste des origines autorisées, transmettez un tableau vide.

Paramètre	Type	Description
id	string (chemin)	Identifiant de l'intake à mettre à jour, préfixé int_.
name	string	Nom interne de l'intake affiché dans la console. 1 à 120 caractères.
allowed_origins	array<string>	Liste des origines HTTP autorisées à charger le widget. Chaque entrée inclut le schéma et le domaine (par exemple https://cabinet-martin.fr).
metadata_policy	string	Politique appliquée aux métadonnées des dépôts. Valeurs acceptées : allow (conservées en clair) ou strip (effacées à la réception).
reference_required	boolean	Force la présence d'une référence client (numéro de dossier) pour valider un dépôt.
enabled	boolean	Active ou désactive le point de réception. Un intake désactivé refuse les nouveaux dépôts mais conserve l'historique.

Codes de statut

Code	Signification
200	L'intake a été mis à jour. La ressource complète est renvoyée.
400	Corps de requête invalide ou valeur hors plage (par exemple metadata_policy inconnue).
401	Clé d'API manquante, expirée ou révoquée.
403	La clé fournie ne porte pas le scope intake_write.
404	Aucun intake ne correspond à l'identifiant fourni dans votre compte.
409	Conflit de version : l'intake a été modifié entre temps. Récupérez-le et réessayez.
429	Limite de débit atteinte. Respectez l'en-tête Retry-After avant de rejouer.

Exemple de requête

Dans l'exemple suivant, vous mettez à jour le nom interne, ajoutez une seconde origine pour un nouveau sous-domaine et rendez la référence client obligatoire. Les champs metadata_policy et enabled ne sont pas modifiés.

curl -X PATCH https://api.coffrify.com/v1/intakes/int_8f3c2a1e \
  -H "Authorization: Bearer $COFFRIFY_API_KEY" \
  -H "Idempotency-Key: update-intake-2026-06-11-001" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Dépôt dossiers fiscalité 2026",
    "allowed_origins": [
      "https://cabinet-martin.fr",
      "https://app.cabinet-martin.fr"
    ],
    "reference_required": true
  }'

Exemple de réponse

La réponse renvoie la ressource complète après application des changements. La publishable_key complète n'est plus exposée après la création : seul un identifiant tronqué apparaît à des fins d'affichage. Si vous avez perdu la clé, regénérez en une nouvelle depuis la console.

{
  "id": "int_8f3c2a1e",
  "object": "intake",
  "name": "Dépôt dossiers fiscalité 2026",
  "slug": "depot-fiscalite",
  "allowed_origins": [
    "https://cabinet-martin.fr",
    "https://app.cabinet-martin.fr"
  ],
  "metadata_policy": "allow",
  "reference_required": true,
  "enabled": true,
  "publishable_key_last4": "a4f9",
  "created_at": "2026-04-02T09:14:21Z",
  "updated_at": "2026-06-11T08:42:03Z"
}

Désactiver sans supprimer

Si vous souhaitez fermer temporairement les dépôts (congés, période fiscale terminée, audit en cours), passez simplement enabled à false. Les dépôts déjà reçus restent consultables et téléchargeables, et l'intake peut être réactivé à tout moment sans changer ses identifiants ni invalider la clé publishable.

curl -X PATCH https://api.coffrify.com/v1/intakes/int_8f3c2a1e \
  -H "Authorization: Bearer $COFFRIFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

Pour suivre l'effet d'une mise à jour, comparez les champs updated_at avant et après l'appel. Cette valeur est fiable pour invalider un cache local de configuration ou pour déclencher une régénération de votre formulaire embarqué.