Skip to main content
POST
/
v1
/
apps
/
{app_id}
/
user_meta_fields
Create user meta field
curl --request POST \
  --url https://{defaultHost}/v1/apps/{app_id}/user_meta_fields \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Authorization: <api-key>'
{
  "id": "field_123",
  "app_id": "<string>",
  "name": "first_name",
  "required": false,
  "visible_profile": true,
  "visible_registration": false,
  "position": 1,
  "as_verification_identifier": false,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API Secret token

​
X-Authorization
string
header
required

User Access token

Path Parameters

​
app_id
string
required

App ID

Response

successful

​
id
string
required

Meta field ID

Example:

"field_123"

​
app_id
string
required

Application ID

​
name
string
required

Meta field name (used as key in user_meta)

Example:

"first_name"

​
field_type
enum<string>
required

Data type of the field

Available options:
string,
boolean,
integer,
date,
phone,
email,
text,
url
​
required
boolean
required

Whether this field is required during user creation

Example:

false

​
visible_profile
boolean
required

Whether field is visible on profile component

Example:

true

​
visible_registration
boolean
required

Whether field is visible during registration/login

Example:

false

​
position
integer
required

Display order position

Example:

1

​
as_verification_identifier
boolean

Can be used as verification identifier (only for email and phone fields)

Example:

false

​
created_at
string<date-time>

Creation timestamp

​
updated_at
string<date-time>

Last update timestamp