Sign in
Users

Create user

Creates a user account. Requires admin privileges.

post/users

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/users
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

emailstring email required

Email address for login and notifications

passwordstring required

Password for user authentication (must meet password requirements)

role'admin' | 'projectOwner' | 'boardUser' required

User role defining access permissions

namestring required

Full display name of the user

usernamestring nullable

Unique username for user identification

phonestring nullable

Contact phone number

organizationstring nullable

Organization or company name

language'ar-YE' | 'bg-BG' | 'ca-ES' | 'cs-CZ' | 'da-DK' | 'de-DE' | 'el-GR' | 'en-GB' | 'en-US' | 'es-ES' | 'et-EE' | 'fa-IR' | 'fi-FI' | 'fr-FR' | 'hu-HU' | 'id-ID' | 'it-IT' | 'ja-JP' | 'ko-KR' | 'nl-NL' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'ro-RO' | 'ru-RU' | 'sk-SK' | 'sr-Cyrl-RS' | 'sr-Latn-RS' | 'sv-SE' | 'tr-TR' | 'uk-UA' | 'uz-UZ' | 'vi-VN' | 'zh-CN' | 'zh-TW' nullable

Preferred language for user interface and notifications (if null - will be set automatically on the first login)

subscribeToOwnCardsboolean

Whether the user subscribes to their own cards

subscribeToCardWhenCommentingboolean

Whether the user subscribes to cards when commenting

turnOffRecentCardHighlightingboolean

Whether recent card highlighting is disabled

Example request

{
  "email": "john.doe@example.com",
  "password": "SecurePassword123!",
  "role": "admin",
  "name": "John Doe",
  "username": "john_doe",
  "phone": "+1234567890",
  "organization": "Acme Corporation",
  "language": "en-US",
  "subscribeToCardWhenCommenting": true
}

Response

User created successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "email": "john.doe@example.com",
    "role": "admin",
    "name": "John Doe",
    "username": "john_doe",
    "avatar": {
      "url": "https://storage.example.com/user-avatars/1357158568008091264/original.jpg",
      "thumbnailUrls": {
        "cover180": "https://storage.example.com/user-avatars/1357158568008091264/cover-180.jpg"
      }
    },
    "gravatarUrl": "https://www.gravatar.com/avatar/abc123",
    "phone": "+1234567890",
    "organization": "Acme Corporation",
    "language": "en-US",
    "apiKeyPrefix": "D89VszVs",
    "subscribeToCardWhenCommenting": true,
    "enableFavoritesByDefault": true,
    "defaultEditorMode": "wysiwyg",
    "defaultHomeView": "groupedProjects",
    "defaultProjectsOrder": "byDefault",
    "lockedFieldNames": [
      "email",
      "password",
      "name"
    ],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.