Add an agent to the desk (a person's seat or an AI agent)

Before you call

Credential

Authorization: Bearer $KEY

Scope

inbox:write

Graphql

Mutation.inboxContactCentreAgentCreate

Sdk

desk.agents.create

Cli

desk agent-add

Request bodyapplication/json, required

• kindstringrequired
  A person's seat or an AI agent's One of: human, ai.
• namestringrequired
  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

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