Praecise Platform
Menu

Rivier/ Reference/ inbox

Change a rule

patch/workspace/inbox/rules/{id}

Before you call

Credential
Authorization: Bearer $KEY
Scope
inbox:write
Graphql
Mutation.inboxRuleUpdate
Sdk
inbox.rule.update
Cli
inbox rule update

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • namestring
    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 object
    • 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 object
  • stopboolean

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