Rivier/ Reference/ inbox

Hand a conversation over

post/contact-centre/conversations/{id}/handoff

Hand a conversation over. To a person: at once, back into the queue. To an AI agent: waits until a person approves.

Before you call

Credential
Authorization: Bearer $KEY
Scope
inbox:write
Mcp
rivier_cc_handoff
Graphql
Mutation.inboxContactCentreHandoffCreate
Sdk
desk.conversations.handoff
Cli
desk handoff

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • agentIdstring (uuid)required
    The seat handing over
  • tostringrequired
    One of: human, ai.
  • reasonstring
    At most 300 characters.
  • toAgentIdstring (uuid)
    The AI agent to hand to

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