Rivier/ Reference/ inbox

Change an agent's name, skills or limit

put/contact-centre/agents/{id}

Before you call

Credential
Authorization: Bearer $KEY
Scope
inbox:write
Graphql
Mutation.inboxContactCentreAgentUpdate
Sdk
desk.agents.update
Cli
desk agent-set

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • kindstring
    A person's seat or an AI agent's One of: human, ai.
  • namestring
    At most 80 characters.
  • userIdstring or null
    The signed-in person this seat belongs to
  • skillslist of string
  • presencestring
    One of: online, away, offline.
  • maxConcurrentinteger
    At least 1. At most 50.

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