Sign in
Users

Create a user

Creates a new user.

post/v1/users

Request

  • Base URL: https://api.sensay.io
  • URL: https://api.sensay.io/v1/users
  • Auth: API key in header X-ORGANIZATION-SECRET

Headers

X-API-Versionstring
Example:2025-03-25
Content-Encoding'gzip'

Content encoding for request body compression. Optional - when used, client is responsible for gzipping and sending binary data.

Request body

emailstring email

The email address

idstring

The ID of the user

namestring

The name of the user (max 50 chars, letters/numbers/spaces and ( ) . , ' - /)

Example request

{
  "email": "user@example.com",
  "linkedAccounts": [
    {
      "accountType": "discord"
    }
  ],
  "name": "John Doe"
}

Response

The created User entity

emailstring email

The email address

idstring required

The ID of the user

namestring

The name of the user

successtrue required

Indicates the request was successful

Example response

{
  "email": "user@example.com",
  "id": "johndoe",
  "linkedAccounts": [
    {
      "accountType": "discord"
    }
  ],
  "name": "John Doe",
  "success": true
}

Changes

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