Create a User

POST

/users

Requires authenticated session. Requires manage:user permission.

Request

Authorization

API Key

Add parameter in cookie

core.session_token

Example:

core.session_token: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Body

🟠400bad-request

🟠401unauthorized

🟠403forbidden

🔴500server-error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/users' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "email": "user@example.com",
    "password": "string",
    "secondaryEmail": "user@example.com",
    "image": "string",
    "active": true
}'

Response Example

201 - Example 1

{
    "success": true,
    "message": "string",
    "meta": {},
    "errors": [
        {
            "code": "string",
            "field": "string",
            "message": "string"
        }
    ],
    "result": {
        "id": "string",
        "name": "string",
        "email": "string",
        "emailVerified": true,
        "secondaryEmail": "string",
        "image": "string",
        "active": true,
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2026-05-01 04:13:11

Get All Users

Retrieve an Existing User