Praecise Platform
Menu

Rivier/ Reference/ campaigns

Tell a person something

post/notify/send

Tell a person something: it goes in their feed, then each channel in their order (push, email, text, WhatsApp) is tried until one carries it, falling back when one fails. A template set chooses the words in their language. The same idempotency key sends once.

Before you call

Credential
Authorization: Bearer $KEY
Scope
campaigns:write
Mcp
rivier_notify_send
Graphql
Mutation.campaignsNotifySend
Sdk
campaigns.notify.send
Cli
campaigns notify send
Events
campaigns.notification.sent, campaigns.notification.failed

Request bodyapplication/json, required

  • userRefstringrequired
    Your own id for the person; Rivier keeps it as given and never shows it to anyone else At most 200 characters.
  • categorystring
    Default: general. Pattern: ^[a-z][a-z0-9_.-]{0,39}$.
  • templatestring
    Pattern: ^[a-z0-9][a-z0-9_.-]{0,59}$.
  • languagestring
    Pattern: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})?$.
  • dataobject
    Default: {}.
  • contentobject
    The words, when no template is named
    • titlestringrequired
      At most 200 characters.
    • bodystring
      Default: . At most 1000 characters.
    • urlstring (uri)
      At most 1000 characters.
    • iconstring (uri)
      At most 1000 characters.
  • channelslist of string
    Try these channels in this order instead of the person's
  • allboolean
    Send on every channel in the order instead of stopping at the first that carries it Default: false.
  • idempotencyKeystring
    At most 200 characters.

Responses

  • 200application/json
    Success
    • 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