Skip to main content
POST
/
v2
/
session
/
apps
/
{appID}
/
users
Create user
curl --request POST \
  --url https://api.prelude.dev/v2/session/apps/{appID}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifiers": [
    {
      "type": "phone_number",
      "value": "<string>"
    }
  ],
  "profile": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>"
}
'
{
  "id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.prelude.so/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
appID
string
required

The id of the app the request refers to. An application's unique identifier.

Examples:

"54e9ujn"

"fvua38g"

Body

application/json
​
identifiers
object[]
required
​
profile
object
Example:
{ "first_name": "John", "last_name": "Doe" }
​
id
string<uuid>
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
external_id
string

ID of the user in your system. Must be at most 128 characters.

Maximum string length: 128
Example:

"customer-user-42"

Response

Created

​
id
string
required

An app's user's unique identifier. It is prefixed with 'usr_'

Examples:

"usr_01jqebhswje1ka1z7ahr9rfsgt"

"usr_01jqy7455pf8p9bap5qke912g1"