---
title: Create a user
slug: create-a-user
docTags:
createdAt: 2026-04-17T07:48:39.600Z
---
{
"id": "HYRjpIKFKAq_1tUHCEkB3",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "https://api.archbee.com/v2/users",
"servers": [
{
"url": "https://api.archbee.com/v2/users",
"description": "Production server"
},
{
"url": "https://staging-api.archbee.com/v2/users",
"description": "Staging server"
},
{
"url": "https://{region}.api.archbee.com/{version}/users",
"description": "Regional server with variables"
}
],
"name": "Create a user",
"description": "Creates a new user account. The request body uses allOf to combine base user fields with creation-specific fields.
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"kind": "optional",
"name": "X-Request-Id",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426614174000",
"description": "Optional correlation ID for request tracing",
"format": "uuid"
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "required",
"name": "body",
"type": "object",
"example": "{\"name\":\"Alice Johnson\",\"email\":\"alice@example.com\",\"password\":\"SecureP@ss123\",\"role\":\"editor\",\"profile\":{\"bio\":\"Software engineer and API enthusiast\",\"avatarUrl\":\"https://example.com/avatars/alice.png\",\"timezone\":\"America/New_York\"}}",
"description": "User data for account creation",
"customType": "CreateUserRequest",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": "",
"example": "Jane Smith",
"minLength": 1,
"maxLength": 100
},
{
"name": "email",
"kind": "required",
"type": "string",
"description": "",
"example": "jane@example.com",
"format": "email"
},
{
"name": "role",
"kind": "optional",
"type": "string",
"description": "",
"example": "",
"default": "viewer",
"enum": [
"admin",
"editor",
"viewer",
"guest"
]
},
{
"name": "profile",
"kind": "optional",
"type": "object",
"description": "User profile details",
"modelRef": "#/components/schemas/UserProfile",
"customType": "UserProfile",
"schema": [
{
"name": "bio",
"kind": "optional",
"type": "string",
"description": "",
"example": "Software engineer and API enthusiast",
"maxLength": 500
},
{
"name": "avatarUrl",
"kind": "optional",
"type": "string",
"description": "",
"example": "https://example.com/avatars/jane.png",
"format": "uri"
},
{
"name": "timezone",
"kind": "optional",
"type": "string",
"description": "",
"example": "America/New_York"
},
{
"name": "socialLinks",
"kind": "optional",
"type": "map",
"description": "",
"example": "{\"github\":\"https://github.com/janesmith\",\"linkedin\":\"https://linkedin.com/in/janesmith\"}",
"customType": "map",
"schema": []
}
]
},
{
"name": "password",
"kind": "required",
"type": "string",
"writeOnly": true,
"description": "Must contain at least one uppercase letter, one lowercase letter, one digit, and one special character",
"example": "SecureP@ss123",
"format": "password",
"minLength": 8,
"maxLength": 128
}
],
"modelRef": "#/components/schemas/CreateUserRequest",
"complexItems": [
{
"name": "object",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": "",
"example": "Jane Smith",
"minLength": 1,
"maxLength": 100
},
{
"name": "email",
"kind": "required",
"type": "string",
"description": "",
"example": "jane@example.com",
"format": "email"
},
{
"name": "role",
"kind": "optional",
"type": "string",
"description": "",
"example": "",
"default": "viewer",
"enum": [
"admin",
"editor",
"viewer",
"guest"
]
},
{
"name": "profile",
"kind": "optional",
"type": "object",
"description": "User profile details",
"modelRef": "#/components/schemas/UserProfile",
"customType": "UserProfile",
"schema": [
{
"name": "bio",
"kind": "optional",
"type": "string",
"description": "",
"example": "Software engineer and API enthusiast",
"maxLength": 500
},
{
"name": "avatarUrl",
"kind": "optional",
"type": "string",
"description": "",
"example": "https://example.com/avatars/jane.png",
"format": "uri"
},
{
"name": "timezone",
"kind": "optional",
"type": "string",
"description": "",
"example": "America/New_York"
},
{
"name": "socialLinks",
"kind": "optional",
"type": "map",
"description": "",
"example": "{\"github\":\"https://github.com/janesmith\",\"linkedin\":\"https://linkedin.com/in/janesmith\"}",
"customType": "map",
"schema": []
}
]
}
],
"modelRef": "#/components/schemas/UserBase",
"customType": "UserBase"
},
{
"name": "object",
"schema": [
{
"name": "password",
"kind": "required",
"type": "string",
"writeOnly": true,
"description": "Must contain at least one uppercase letter, one lowercase letter, one digit, and one special character",
"example": "SecureP@ss123",
"format": "password",
"minLength": 8,
"maxLength": 128
}
]
}
],
"complexType": "allOf",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "bearerAuth",
"name": "bearerAuth",
"kind": "optional",
"type": "http",
"description": "HTTP Bearer token authentication (JWT)
",
"scheme": "bearer"
}
]
},
"responses": [
{
"statusCode": "201",
"description": "User created successfully",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "Full user object returned in API responses. Uses `allOf` to merge base fields with response-specific fields.",
"customType": "User",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": "",
"example": "Jane Smith",
"minLength": 1,
"maxLength": 100
},
{
"name": "email",
"kind": "required",
"type": "string",
"description": "",
"example": "jane@example.com",
"format": "email"
},
{
"name": "role",
"kind": "optional",
"type": "string",
"description": "",
"example": "",
"default": "viewer",
"enum": [
"admin",
"editor",
"viewer",
"guest"
]
},
{
"name": "profile",
"kind": "optional",
"type": "object",
"description": "User profile details",
"modelRef": "#/components/schemas/UserProfile",
"customType": "UserProfile",
"schema": [
{
"name": "bio",
"kind": "optional",
"type": "string",
"description": "",
"example": "Software engineer and API enthusiast",
"maxLength": 500
},
{
"name": "avatarUrl",
"kind": "optional",
"type": "string",
"description": "",
"example": "https://example.com/avatars/jane.png",
"format": "uri"
},
{
"name": "timezone",
"kind": "optional",
"type": "string",
"description": "",
"example": "America/New_York"
},
{
"name": "socialLinks",
"kind": "optional",
"type": "map",
"description": "",
"example": "{\"github\":\"https://github.com/janesmith\",\"linkedin\":\"https://linkedin.com/in/janesmith\"}",
"customType": "map",
"schema": []
}
]
},
{
"name": "id",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "",
"example": "550e8400-e29b-41d4-a716-446655440000",
"format": "uuid"
},
{
"name": "status",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "",
"example": "active",
"enum": [
"active",
"inactive",
"suspended",
"pending"
]
},
{
"name": "createdAt",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "",
"example": "2025-01-15T09:30:00Z",
"format": "date-time"
},
{
"name": "updatedAt",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "",
"example": "2025-06-01T14:22:00Z",
"format": "date-time"
},
{
"name": "permissions",
"kind": "optional",
"type": "array",
"readOnly": true,
"description": "",
"example": "[\"read\",\"write\",\"admin\"]",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
}
],
"modelRef": "#/components/schemas/User",
"complexItems": [
{
"name": "object",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": "",
"example": "Jane Smith",
"minLength": 1,
"maxLength": 100
},
{
"name": "email",
"kind": "required",
"type": "string",
"description": "",
"example": "jane@example.com",
"format": "email"
},
{
"name": "role",
"kind": "optional",
"type": "string",
"description": "",
"example": "",
"default": "viewer",
"enum": [
"admin",
"editor",
"viewer",
"guest"
]
},
{
"name": "profile",
"kind": "optional",
"type": "object",
"description": "User profile details",
"modelRef": "#/components/schemas/UserProfile",
"customType": "UserProfile",
"schema": [
{
"name": "bio",
"kind": "optional",
"type": "string",
"description": "",
"example": "Software engineer and API enthusiast",
"maxLength": 500
},
{
"name": "avatarUrl",
"kind": "optional",
"type": "string",
"description": "",
"example": "https://example.com/avatars/jane.png",
"format": "uri"
},
{
"name": "timezone",
"kind": "optional",
"type": "string",
"description": "",
"example": "America/New_York"
},
{
"name": "socialLinks",
"kind": "optional",
"type": "map",
"description": "",
"example": "{\"github\":\"https://github.com/janesmith\",\"linkedin\":\"https://linkedin.com/in/janesmith\"}",
"customType": "map",
"schema": []
}
]
}
],
"modelRef": "#/components/schemas/UserBase",
"customType": "UserBase"
},
{
"name": "object",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "",
"example": "550e8400-e29b-41d4-a716-446655440000",
"format": "uuid"
},
{
"name": "status",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "",
"example": "active",
"enum": [
"active",
"inactive",
"suspended",
"pending"
]
},
{
"name": "createdAt",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "",
"example": "2025-01-15T09:30:00Z",
"format": "date-time"
},
{
"name": "updatedAt",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "",
"example": "2025-06-01T14:22:00Z",
"format": "date-time"
},
{
"name": "permissions",
"kind": "optional",
"type": "array",
"readOnly": true,
"description": "",
"example": "[\"read\",\"write\",\"admin\"]",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
}
]
}
],
"complexType": "allOf",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "Bad request — invalid input or missing required fields",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"code\":\"BAD_REQUEST\",\"message\":\"The request body is invalid\",\"details\":[{\"field\":\"email\",\"message\":\"must be a valid email address\",\"code\":\"INVALID_FORMAT\"}]}",
"description": "Standard error response",
"customType": "Error",
"schema": [
{
"name": "code",
"kind": "required",
"type": "string",
"description": "Machine-readable error code",
"example": "VALIDATION_ERROR"
},
{
"name": "message",
"kind": "required",
"type": "string",
"description": "Human-readable error message",
"example": "The request body contains invalid fields"
},
{
"name": "details",
"kind": "optional",
"type": "array",
"description": "Detailed validation errors (when applicable)",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "field",
"kind": "optional",
"type": "string",
"description": "",
"example": "email"
},
{
"name": "message",
"kind": "optional",
"type": "string",
"description": "",
"example": "must be a valid email address"
},
{
"name": "code",
"kind": "optional",
"type": "string",
"description": "",
"example": "INVALID_FORMAT"
}
]
},
{
"name": "requestId",
"kind": "optional",
"type": "string",
"description": "Correlation ID for support inquiries",
"example": "",
"format": "uuid"
}
],
"modelRef": "#/components/schemas/Error",
"isExpanded": true
}
]
},
{
"statusCode": "409",
"description": "User with this email already exists",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"code\":\"CONFLICT\",\"message\":\"A user with email alice@example.com already exists\"}",
"description": "Standard error response",
"customType": "Error",
"schema": [
{
"name": "code",
"kind": "required",
"type": "string",
"description": "Machine-readable error code",
"example": "VALIDATION_ERROR"
},
{
"name": "message",
"kind": "required",
"type": "string",
"description": "Human-readable error message",
"example": "The request body contains invalid fields"
},
{
"name": "details",
"kind": "optional",
"type": "array",
"description": "Detailed validation errors (when applicable)",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "field",
"kind": "optional",
"type": "string",
"description": "",
"example": "email"
},
{
"name": "message",
"kind": "optional",
"type": "string",
"description": "",
"example": "must be a valid email address"
},
{
"name": "code",
"kind": "optional",
"type": "string",
"description": "",
"example": "INVALID_FORMAT"
}
]
},
{
"name": "requestId",
"kind": "optional",
"type": "string",
"description": "Correlation ID for support inquiries",
"example": "",
"format": "uuid"
}
],
"modelRef": "#/components/schemas/Error",
"isExpanded": true
}
]
},
{
"statusCode": "422",
"description": "Unprocessable entity — validation failed",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"code\":\"VALIDATION_ERROR\",\"message\":\"The request body failed validation\",\"details\":[{\"field\":\"price\",\"message\":\"must be greater than 0\",\"code\":\"INVALID_VALUE\"},{\"field\":\"name\",\"message\":\"must be between 1 and 200 characters\",\"code\":\"INVALID_LENGTH\"}]}",
"description": "Standard error response",
"customType": "Error",
"schema": [
{
"name": "code",
"kind": "required",
"type": "string",
"description": "Machine-readable error code",
"example": "VALIDATION_ERROR"
},
{
"name": "message",
"kind": "required",
"type": "string",
"description": "Human-readable error message",
"example": "The request body contains invalid fields"
},
{
"name": "details",
"kind": "optional",
"type": "array",
"description": "Detailed validation errors (when applicable)",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "field",
"kind": "optional",
"type": "string",
"description": "",
"example": "email"
},
{
"name": "message",
"kind": "optional",
"type": "string",
"description": "",
"example": "must be a valid email address"
},
{
"name": "code",
"kind": "optional",
"type": "string",
"description": "",
"example": "INVALID_FORMAT"
}
]
},
{
"name": "requestId",
"kind": "optional",
"type": "string",
"description": "Correlation ID for support inquiries",
"example": "",
"format": "uuid"
}
],
"modelRef": "#/components/schemas/Error",
"isExpanded": true
}
]
},
{
"statusCode": "500",
"description": "Internal server error",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"code\":\"INTERNAL_ERROR\",\"message\":\"An unexpected error occurred. Please try again later.\",\"requestId\":\"123e4567-e89b-12d3-a456-426614174000\"}",
"description": "Standard error response",
"customType": "Error",
"schema": [
{
"name": "code",
"kind": "required",
"type": "string",
"description": "Machine-readable error code",
"example": "VALIDATION_ERROR"
},
{
"name": "message",
"kind": "required",
"type": "string",
"description": "Human-readable error message",
"example": "The request body contains invalid fields"
},
{
"name": "details",
"kind": "optional",
"type": "array",
"description": "Detailed validation errors (when applicable)",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "field",
"kind": "optional",
"type": "string",
"description": "",
"example": "email"
},
{
"name": "message",
"kind": "optional",
"type": "string",
"description": "",
"example": "must be a valid email address"
},
{
"name": "code",
"kind": "optional",
"type": "string",
"description": "",
"example": "INVALID_FORMAT"
}
]
},
{
"name": "requestId",
"kind": "optional",
"type": "string",
"description": "Correlation ID for support inquiries",
"example": "",
"format": "uuid"
}
],
"modelRef": "#/components/schemas/Error",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "r4Wja0t-zm4KUvhJ6BNTr",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n --url https://api.archbee.com/v2/users \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data-raw '{\n \"name\": \"Jane Smith\",\n \"email\": \"jane@example.com\",\n \"role\": \"viewer\",\n \"password\": \"SecureP@ss123\"\n }'"
},
{
"id": "sgZXQS66lOs5TY-YzBJQx",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"name\": \"Jane Smith\",\n \"email\": \"jane@example.com\",\n \"role\": \"viewer\",\n \"password\": \"SecureP@ss123\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.archbee.com/v2/users\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "ePaE6bYUuDQLcDHb3Aaz2",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.archbee.com/v2/users\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"name\": \"Jane Smith\",\n \"email\": \"jane@example.com\",\n \"role\": \"viewer\",\n \"password\": \"SecureP@ss123\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "FPnoCzgvCTHJd2C--w9P5",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.archbee.com/v2/users\"\n\npayload = json.dumps({\n \"name\": \"Jane Smith\",\n \"email\": \"jane@example.com\",\n \"role\": \"viewer\",\n \"password\": \"SecureP@ss123\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "r4Wja0t-zm4KUvhJ6BNTr"
},
"results": {
"languages": [
{
"id": "7XGNepD-De1DR0C6mbRsA",
"language": "201",
"code": "// User created successfully\n{\n \"name\": \"Jane Smith\",\n \"email\": \"jane@example.com\",\n \"role\": \"\",\n \"profile\": {\n \"bio\": \"Software engineer and API enthusiast\",\n \"avatarUrl\": \"https://example.com/avatars/jane.png\",\n \"timezone\": \"America/New_York\",\n \"socialLinks\": \"{\\\"github\\\":\\\"https://github.com/janesmith\\\",\\\"linkedin\\\":\\\"https://linkedin.com/in/janesmith\\\"}\"\n },\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"status\": \"active\",\n \"createdAt\": \"2025-01-15T09:30:00Z\",\n \"updatedAt\": \"2025-06-01T14:22:00Z\",\n \"permissions\": [\n \"\"\n ]\n}"
},
{
"id": "qpUjMXhsB7H58lI_Ohz1_",
"language": "400",
"code": "// Bad request — invalid input or missing required fields\n{\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"The request body contains invalid fields\",\n \"details\": [\n {\n \"field\": \"email\",\n \"message\": \"must be a valid email address\",\n \"code\": \"INVALID_FORMAT\"\n }\n ],\n \"requestId\": \"\"\n}"
},
{
"id": "CMbw031WJy-_9h_uXqKYA",
"language": "409",
"code": "// User with this email already exists\n{\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"The request body contains invalid fields\",\n \"details\": [\n {\n \"field\": \"email\",\n \"message\": \"must be a valid email address\",\n \"code\": \"INVALID_FORMAT\"\n }\n ],\n \"requestId\": \"\"\n}"
},
{
"id": "ah9kgKQwI3xi-12afCtun",
"language": "422",
"code": "// Unprocessable entity — validation failed\n{\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"The request body contains invalid fields\",\n \"details\": [\n {\n \"field\": \"email\",\n \"message\": \"must be a valid email address\",\n \"code\": \"INVALID_FORMAT\"\n }\n ],\n \"requestId\": \"\"\n}"
},
{
"id": "H66H-_Pcb4HjXXMluNfER",
"language": "500",
"code": "// Internal server error\n{\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"The request body contains invalid fields\",\n \"details\": [\n {\n \"field\": \"email\",\n \"message\": \"must be a valid email address\",\n \"code\": \"INVALID_FORMAT\"\n }\n ],\n \"requestId\": \"\"\n}"
}
],
"selectedLanguageId": "7XGNepD-De1DR0C6mbRsA"
}
},
"children": [
{
"text": ""
}
]
}