Aller au contenu
Envoyer des données/Envoyer l'objectif de l'exercice

Envoyer l'objectif de l'exercice

Dépose l'objectif de nouveau revenu de l'exercice : celui de l'entreprise, celui du marketing, ou les deux.

Pour l'exercice en cours ou le suivant. granularity dit comment les montants sont donnés : 12 montants par mois, 4 par trimestre, 2 par semestre, 1 pour l'année, en centimes, dans l'ordre de l'exercice. L'objectif du marketing est une suite de montants, ou une part de l'objectif de l'entreprise en points de base (2 500 pour 25 %).

Rien ne change à l'envoi. Qui fixe les objectifs voit la proposition sur l'écran Objectifs, à côté de l'objectif en vigueur, et l'applique ou la refuse. Appliquée, elle devient une nouvelle version de l'objectif, répartie sur les mois comme l'écran les répartit.

Un envoi plus récent pour le même exercice remplace celui qui attend. Les objectifs par canal, les taux et les objectifs par étape se fixent à l'écran.

Appel

RepèreValeur
AdressePOST /api/v1/objectives/proposals
Par son nomPOST /api/v1/tools/propose_objectives, la réponse sous data
Nom de l'outilpropose_objectives
Droit demandéFixer l'objectif de l'entreprise et du marketing (objectives.set)
Rôles qui ont ce droit par défautPropriétaire, CMO
Par MCPOui : l'envoi attend une personne.

Paramètres

Les paramètres sont dans le corps de la requête, en JSON.

ParamètreRequisType et limitesÀ quoi il sert
yearStartouimois, AAAA-MMLe premier mois de l'exercice.
granularityouivaleur au choix, month, quarter, semester, yearLe pas des montants : month, quarter, semester ou year.
companyouiliste de nombres entiers, 12 éléments au plus, ou nullLes montants de l'entreprise, en centimes, ou null pour ne pas la proposer.
marketingouiobjet, ou nullL'objectif du marketing, ou null pour ne pas le proposer.
marketing.kindouivaleur au choix, amounts, shareamounts pour des montants, share pour une part de l'objectif de l'entreprise.
marketing.amountsouiliste de nombres entiers, 12 éléments au plus, quand kind vaut amountsLes montants du marketing, en centimes.
marketing.shareBpsouinombre entier, de 1 à 10 000, quand kind vaut shareLa part du marketing dans l'objectif de l'entreprise, en points de base.
notenontexte, 500 caractères au plusUn mot pour qui examine la proposition.

Exemple

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

Le fichier corps.json :

{
  "yearStart": "2027-01",
  "granularity": "year",
  "company": [500000000],
  "marketing": {
    "kind": "share",
    "shareBps": 3000
  },
  "note": "Objectif retenu en comité de direction."
}

Réponse

proposalId et superseded (les propositions en attente remplacées).

{
  "proposalId": "PROPOSAL_ID",
  "superseded": 0
}

Refus

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