Skip to main content
POST
/
environments
/
{environmentId}
/
custom
/
fields
Create a custom field for the environment
curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/custom/fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "An example name",
  "enabled": true,
  "required": true,
  "position": 123,
  "validationRules": {
    "unique": true,
    "regex": "^0x",
    "validOptions": [
      {
        "label": "small"
      },
      {
        "label": "medium"
      },
      {
        "label": "large"
      }
    ],
    "checkboxText": "Agree to the terms and conditions"
  }
}
'
{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "key": "An example name",
  "name": "An example name",
  "enabled": true,
  "required": true,
  "position": 123,
  "validationRules": {
    "unique": true,
    "regex": "^0x",
    "validOptions": [
      {
        "label": "small"
      },
      {
        "label": "medium"
      },
      {
        "label": "large"
      }
    ],
    "checkboxText": "Agree to the terms and conditions"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.dynamic.xyz/docs/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

​
environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json
​
name
string
required
Maximum string length: 255
Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

​
enabled
boolean
required

When true the field is visible in user forms; when false it is hidden but existing data persists

​
required
boolean
required

When true users must fill this field to complete onboarding

​
fieldType
enum<string>
required
Available options:
text,
checkbox,
select
​
position
number
required

Zero-based display order in the onboarding form — lower values appear first

​
validationRules
object

Optional validation rules for the custom field

Response

Custom field created successfully

​
id
string
required
Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

​
key
string
required
Maximum string length: 255
Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

​
name
string
required
Maximum string length: 255
Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

​
enabled
boolean
required

A flag indicating whether the custom field is active.

​
required
boolean
required

A flag indicating whether the custom field is required.

​
fieldType
enum<string>
required
Available options:
text,
checkbox,
select
​
position
number
required

Zero-based display order in the onboarding form — lower values appear first

​
validationRules
object

Optional validation rules for the custom field