klink-developers-logo

User

Create

POST/api/v1/users

Creates a user (agent) in your workspace. The account is usable immediately — the person does not need to be invited or to log in first, which is the point of this endpoint.

roleIds must contain at least one role ID from Role → Listing. An unrecognised ID is rejected with 422, so fetch the list once and cache it.

The account becomes loginable a moment after this call returns. The response is 201 as soon as the user is stored, while the sign-in directory is updated asynchronously. In practice this is a second or two. If a caller reports that a brand-new account cannot sign in, re-read it with Detail and retry the login rather than creating the user again.

An email address must be unique across all of klink.cloud, not just your workspace. Reusing one returns 422.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Body Paramsapplication/json
  • namestringrequired

    Display name. Cannot contain @.

  • emailstringrequired

    Sign-in address. Must be globally unique.

  • passwordstringrequired

    Initial sign-in password. Sent to you only in this request; never returned by any endpoint.

  • roleIdsarray[string]required

    One or more role IDs from Role → Listing.

  • phonestring | nulloptional
  • addressstring | nulloptional
  • globalAgentCapacityinteger | nulloptional

    Optional cap on concurrent conversations.

Responses

201

Created

  • requestIdstringrequired

    Unique ID for this request. Quote it when reporting a problem.

  • dataobjectrequired
    Child attributes
    • idstringrequired
    • namestringrequired
    • emailstringrequired
    • phonestring | nullrequired
    • addressstring | nullrequired
    • globalAgentCapacityinteger | nullrequired

      Maximum concurrent conversations for this agent, or null to fall back to the queue setting.

    • rolesarray[object]required
      Child attributes
      • idstringrequired

        Role ID. Use this in roleIds when creating or updating a user.

      • systemNamestringrequired
      • displayNamestringrequired
      • descriptionstring | nullrequired
    • createdAtstringrequired
    • updatedAtstringrequired
401

Unauthorized

  • messagestringrequired
422

Unprocessable Entity

  • messagestringrequired
429

Too Many Requests

  • messagestringrequired
503

Service Unavailable

  • messagestringrequired