Praecise Platform
Menu

Rivier/ Reference/ inbox

Change an inbox or its autonomy mode

patch/workspace/inboxes/{id}

Before you call

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

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • namestring
    At most 120 characters.
  • purposestring
    At most 2000 characters.
  • agentIdstring (uuid) or null
  • sharedboolean
  • modestring
    One of: off, watch, ask, auto.

Responses

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