Skip to main content
POST
/
v1
/
users
Create a user
curl --request POST \
  --url https://api.stockly.com/v1/users \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "jane@example.com",
  "externalId": "acme-user-42"
}
'
{
  "user": {
    "id": "6f1d2a3b-7c8d-4e9f-a0b1-c2d3e4f5a6b7",
    "appId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "email": "jane@example.com",
    "externalId": "acme-user-42",
    "createdAt": "2026-06-13T12:00:00.000Z"
  }
}

Authorizations

​
x-api-key
string
header
required

Your Stockly API key. Identifies your app; you never pass an app id.

Body

application/json

At least one of email or externalId is required.

​
email
string<email>

Unique within your app.

Maximum string length: 320
​
externalId
string

Your own user identifier. Unique within your app.

Required string length: 1 - 128

Response

User created

​
user
object