Praecise Platform
Menu

Rivier/ Reference/ inbox

Make a rule (owner or manager)

post/workspace/inbox/rules

Make a rule (owner or manager): when conditions on the sender, subject, text, mailbox, attachment or language hold, label, assign, route to an agent, set a status, archive or mark as junk.

Before you call

Credential
Authorization: Bearer $KEY
Scope
inbox:write
Graphql
Mutation.inboxRuleCreate
Sdk
inbox.rule.create
Cli
inbox rule create

Request bodyapplication/json, required

  • namestringrequired
    At most 80 characters.
  • enabledboolean
  • positioninteger
    At least 0. At most 1000.
  • scopeInboxstring (uuid) or null
  • scopeMailboxstring or null
  • matchstring
    One of: all, any.
  • conditionslist of objectrequired
    • fieldstringrequired
      One of: from, from_domain, to, subject, body, mailbox, has_attachment, is_reply, category, sentiment, lang, label.
    • opstringrequired
      One of: contains, not_contains, equals, not_equals, starts_with, ends_with, matches, is_true, is_false.
    • valuestring
      At most 200 characters.
  • actionslist of objectrequired
  • stopboolean

Responses

  • 201application/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