Create a user

POST /v1/users
Organization service token

Creates a new user.

Headers

application/json

Body

  • name string

    The name of the user

  • email string(email)

    The email address

  • id string

    The ID of the user

  • linkedAccounts array[object]
    Hide linkedAccounts attributes Show linkedAccounts attributes object
    • accountID string Required

      The account ID

    • accountType string Required

      The account type

      Values are discord, telegram, or embed.

Responses

  • 200 application/json

    The created User entity

    Hide response attributes Show response attributes object
    • name string

      The name of the user

    • email string(email)

      The email address

    • id string Required

      The ID of the user

      Minimum length is 1.

    • linkedAccounts array[object]
      Hide linkedAccounts attributes Show linkedAccounts attributes object
      • accountID string Required

        The account ID

      • accountType string Required

        The account type

        Values are discord, telegram, or embed.
  • 409 application/json

    User, email, or linked account already exists

    Hide response attributes Show response attributes object
    • success boolean Required

      Indicates the status of the request

    • error string Required

      A text representation of the error

    • fingerprint string

      A unique identifier of the event, useful for reporting

    • request_id string Required

      A unique identifier of the request, useful for reporting
POST /v1/users 
curl \
 --request POST 'https://api.sensay.io/v1/users' \
 --header "X-ORGANIZATION-SECRET: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "X-API-Version: 2025-03-25" \
 --data '{"name":"John Doe","email":"user@example.com","id":"string","linkedAccounts":[{"accountID":"string","accountType":"discord"}]}'
Request examples 
# Headers
X-API-Version: 2025-03-25

# Payload
{
  "name": "John Doe",
  "email": "user@example.com",
  "id": "string",
  "linkedAccounts": [
    {
      "accountID": "string",
      "accountType": "discord"
    }
  ]
}
Response examples (200) 
{
  "name": "John Doe",
  "email": "user@example.com",
  "id": "johndoe",
  "linkedAccounts": [
    {
      "accountID": "string",
      "accountType": "discord"
    }
  ]
}
Response examples (409) 
{
  "success": true,
  "error": "string",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b",
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab"
}