Rivier/ Reference/ contacts

Make a marketing plan

post/crm/marketing/plans

Make a marketing plan: the outcome wanted, the measure, the window, the channels, the words to avoid, the hypothesis and the rule for deciding. Nothing is sent or spent.

Before you call

Credential
Authorization: Bearer $KEY
Scope
contacts:write
Graphql
Mutation.contactsMarketingPlanCreate
Sdk
contacts.marketing.planCreate
Cli
contacts marketing plan create

Request bodyapplication/json, required

  • namestringrequired
    At most 160 characters.
  • goalobjectrequired
    • outcomestringrequired
      At most 300 characters.
    • metricstringrequired
      One of: signups, clicks, orders, bookings, revenue, replies.
    • targetnumber or null
      Default: null.
    • fromstringrequired
      Pattern: ^\d{4}-\d{2}-\d{2}$.
    • tostringrequired
      Pattern: ^\d{4}-\d{2}-\d{2}$.
  • constraintsobjectrequired
    • channelslist of stringrequired
    • monthlyBudgetMinorinteger
      Default: 0. At least 0.
    • segmentIdstring (uuid)
    • doNotSaylist of string
      Default: [].
    • capacityNotestring
      At most 300 characters.
  • hypothesisstringrequired
    At most 400 characters.
  • decisionRulestringrequired
    At most 400 characters.

Responses

  • 201application/json
    Success

    object

  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown