Make an inbox for the website widget

Before you call

Credential

Authorization: Bearer $KEY

Scope

inbox:write

Graphql

Mutation.inboxInboxCreate

Sdk

inbox.inbox.create

Cli

inbox inbox create

Request bodyapplication/json, required

• namestringrequired
  At most 120 characters.
• purposestring
  At most 2000 characters.
• agentIdstring (uuid) or null
• sharedboolean

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