Praecise Platform
Menu

Rivier/ Reference/ inbox

Make a mailbox inside the plan

post/workspace/mailboxes

Make a mailbox inside the plan: shared, a team member’s, an agent’s or send-only.

Before you call

Credential
Authorization: Bearer $KEY
Scope
inbox:write
Mcp
rivier_mailbox_allocate
Graphql
Mutation.inboxMailboxCreate
Sdk
inbox.mailbox.create
Cli
inbox mailbox create

Request bodyapplication/json, required

  • kindstringrequired
    One of: shared, human, agent, machine.
  • localpartstring
    At most 64 characters.
  • handlestring
    At most 64 characters.
  • templatestring
    At most 64 characters.
  • memberIdstring
    At most 80 characters.
  • memberNamestring
    At most 120 characters.
  • agentIdstring
    At most 80 characters.
  • memberslist of string
  • routeTostring or null
  • domainstring
    At most 253 characters.
  • namestring
    At most 120 characters.

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