Aller au contenu
Envoyer des données/Écrire des lignes dans le brouillon d'un budget

Écrire des lignes dans le brouillon d'un budget

Écrit des lignes dans le brouillon d'un budget, comme le ferait l'import d'un fichier.

Une ligne envoyée avec sa lineKey met à jour cette ligne. Sans lineKey, elle est créée. Donnez douze montants mensuels ou un montant annuel, en centimes. Tout l'envoi est écrit, ou rien.

Aucun chiffre ne bouge : le brouillon se publie à l'écran, par qui modifie le budget. Un budget déjà publié n'a pas de brouillon : démarrez une révision à l'écran avant d'envoyer. Par MCP, cet appel est refusé.

Appel

RepèreValeur
AdressePOST /api/v1/budgets/:budgetId/lines
Par son nomPOST /api/v1/tools/import_budget_lines, la réponse sous data
Nom de l'outilimport_budget_lines
Droit demandéModifier le budget, les scénarios et le budget N+1 (budget.edit)
Rôles qui ont ce droit par défautPropriétaire, CMO, Marketing Ops
Par MCPNon : cet appel écrit des données. Une application connectée par MCP propose, une personne valide.

Paramètres

budgetId est dans l'adresse. Les autres sont dans le corps de la requête, en JSON.

ParamètreRequisType et limitesÀ quoi il sert
budgetIdouitexte, non videLe budget. list_budgets donne les identifiants.
linesouiliste d'objets, 1 à 500 élémentsLes lignes à écrire.
lines[].lineKeynontexteLa clé d'une ligne du brouillon, pour la mettre à jour.
lines[].kindouivaleur au choix, line, reserveline pour une ligne de budget, reserve pour la réserve.
lines[].channelKeynontexteLe canal de la ligne : une clé du catalogue (paid_media, events, content…).
lines[].programNamenontexteLe programme de la ligne.
lines[].labelouitexte, non videLe nom de la ligne.
lines[].monthlyCentsnonliste de nombres entiers, 12 élémentsLes douze montants de la ligne, du premier au dernier mois du budget, en centimes.
lines[].annualCentsnonnombre entierLe montant de l'année, en centimes, à la place des douze mois.

Exemple

curl -X POST "$MARVESTO_URL/api/v1/budgets/BUDGET_ID/lines" \
  -H "x-api-key: $MARVESTO_API_KEY" \
  -H "content-type: application/json" \
  -d @corps.json

Le fichier corps.json :

{
  "lines": [
    {
      "kind": "line",
      "channelKey": "events",
      "programName": "Salons",
      "label": "Salon B2B Paris",
      "annualCents": 4800000
    }
  ]
}

Réponse

created et updated : le nombre de lignes créées et mises à jour.

{
  "created": 1,
  "updated": 0
}

Refus

Un refus répond { "message": "…" }, en français, avec son statut HTTP : voir Droits et erreurs.