Create an end-user

Create a new end-user within an application. At least one of name, email, or externalId should be provided for identification.

POST/api/end-users

Authorization

better-auth.session_token<token>

Cookie session from Better Auth. Requires X-Org-Id header for org-scoped routes.

In: cookie

Header Parameters

X-Org-Id?string

Organization ID. Required for cookie auth. Not needed for API key auth (org resolved from key).

Formatuuid

Idempotency-Key?string

Unique key for idempotent requests (max 255 chars). Prevents duplicate resource creation on retries. Cached for 24 hours.

Lengthlength <= 255

Request Body

application/json

applicationId?string

ID of the application this end-user belongs to (app_ prefix). Defaults to the organization's default application if omitted.

name?|

Display name of the end-user

Lengthlength <= 200

email?|

Email address of the end-user

Formatemail

externalId?|

Your system's unique identifier for this end-user

Lengthlength <= 255

metadata?|

Arbitrary key-value metadata

curl -X POST "https://loading/api/end-users" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "applicationId": "string",
  "name": "string",
  "email": "[email protected]",
  "externalId": "string",
  "metadata": {},
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "type": "https://docs.appstrate.dev/errors/invalid-request",
  "title": "Invalid Request",
  "status": 400,
  "detail": "Field is required",
  "code": "invalid_request",
  "requestId": "req_abc123"
}

{
  "type": "https://docs.appstrate.dev/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Invalid or missing session",
  "code": "unauthorized",
  "requestId": "req_abc123"
}

{
  "type": "https://docs.appstrate.dev/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "Insufficient permissions",
  "code": "forbidden",
  "requestId": "req_abc123"
}

{
  "type": "https://docs.appstrate.dev/errors/idempotency-in-progress",
  "title": "Idempotency In Progress",
  "status": 409,
  "detail": "A request with the same Idempotency-Key is already being processed. Please wait and retry.",
  "code": "idempotency_in_progress",
  "requestId": "req_abc123"
}

{
  "type": "https://docs.appstrate.dev/errors/idempotency-conflict",
  "title": "Idempotency Conflict",
  "status": 422,
  "detail": "This Idempotency-Key was already used with a different request body. Use a new key for different requests.",
  "code": "idempotency_conflict",
  "requestId": "req_abc123"
}