Rivier/ Reference/ contacts

Draft an email or text campaign for a plan in the project's voice

post/crm/marketing/plans/{id}/campaign-draft

Draft an email or text campaign for a plan in the project's voice; it is an ordinary draft campaign that a person reviews and approves.

Before you call

Credential
Authorization: Bearer $KEY
Scope
contacts:write
Graphql
Mutation.contactsMarketingCampaignDraft
Sdk
contacts.marketing.campaignDraft
Cli
contacts marketing campaign draft

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • briefstringrequired
    At most 1200 characters.
  • namestring
    At most 160 characters.
  • scheduledForstring
    At most 40 characters.
  • reasonstring
    At most 300 characters.
  • channelstring
    One of: email, sms. Default: email.

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