Update an existing custom field by its ID

Updates the specified custom field.

PUT /custom/fields/{customFieldId}

Update an existing custom field by its ID

cURL

curl --request PUT \
  --url https://app.dynamicauth.com/api/v0/custom/fields/{customFieldId} \
  --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"
  }
}
'

import requests

url = "https://app.dynamicauth.com/api/v0/custom/fields/{customFieldId}"

payload = {
    "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"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
    }
  })
};

fetch('https://app.dynamicauth.com/api/v0/custom/fields/{customFieldId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.dynamicauth.com/api/v0/custom/fields/{customFieldId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.dynamicauth.com/api/v0/custom/fields/{customFieldId}"

	payload := strings.NewReader("{\n  \"name\": \"An example name\",\n  \"enabled\": true,\n  \"required\": true,\n  \"position\": 123,\n  \"validationRules\": {\n    \"unique\": true,\n    \"regex\": \"^0x\",\n    \"validOptions\": [\n      {\n        \"label\": \"small\"\n      },\n      {\n        \"label\": \"medium\"\n      },\n      {\n        \"label\": \"large\"\n      }\n    ],\n    \"checkboxText\": \"Agree to the terms and conditions\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://app.dynamicauth.com/api/v0/custom/fields/{customFieldId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"An example name\",\n  \"enabled\": true,\n  \"required\": true,\n  \"position\": 123,\n  \"validationRules\": {\n    \"unique\": true,\n    \"regex\": \"^0x\",\n    \"validOptions\": [\n      {\n        \"label\": \"small\"\n      },\n      {\n        \"label\": \"medium\"\n      },\n      {\n        \"label\": \"large\"\n      }\n    ],\n    \"checkboxText\": \"Agree to the terms and conditions\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/custom/fields/{customFieldId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"An example name\",\n  \"enabled\": true,\n  \"required\": true,\n  \"position\": 123,\n  \"validationRules\": {\n    \"unique\": true,\n    \"regex\": \"^0x\",\n    \"validOptions\": [\n      {\n        \"label\": \"small\"\n      },\n      {\n        \"label\": \"medium\"\n      },\n      {\n        \"label\": \"large\"\n      }\n    ],\n    \"checkboxText\": \"Agree to the terms and conditions\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "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"
  }
}

{
  "error": "<string>"
}

{
  "error": "No jwt provided!"
}

{
  "error": "Access Forbidden"
}

{
  "error": "Resources already exists for this Object",
  "payload": {
    "email": "[e-mail]",
    "embeddedWalletName": "<string>",
    "mergeConflicts": {
      "fromUser": {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
        "verifiedCredentials": [
          {
            "id": "95b11417-f18f-457f-8804-68e361f9164f",
            "signInEnabled": true,
            "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
            "chain": "<string>",
            "refId": "95b11417-f18f-457f-8804-68e361f9164f",
            "signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
            "email": "[e-mail]",
            "name_service": {
              "avatar": "<string>",
              "name": "<string>"
            },
            "public_identifier": "<string>",
            "wallet_name": "<string>",
            "wallet_properties": {
              "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
              "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
              "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
              "isAuthenticatorAttached": true,
              "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f",
              "isSessionKeyCompatible": true
            },
            "business_account_properties": {
              "businessAccountId": "95b11417-f18f-457f-8804-68e361f9164f",
              "businessAccountCreatedAt": "2023-11-07T05:31:56Z",
              "businessAccountSignerId": "95b11417-f18f-457f-8804-68e361f9164f",
              "businessAccountName": "<string>",
              "businessAccountExternalRef": "<string>"
            },
            "oauth_username": "<string>",
            "oauth_display_name": "<string>",
            "oauth_account_id": "<string>",
            "phoneNumber": "9171113333",
            "phoneCountryCode": "1",
            "isoCountryCode": "US",
            "oauth_account_photos": [
              "<string>"
            ],
            "oauth_emails": [
              "<string>"
            ],
            "oauth_metadata": {},
            "previous_users": [
              "95b11417-f18f-457f-8804-68e361f9164f"
            ],
            "embedded_wallet_id": "<string>",
            "wallet_additional_addresses": [
              {
                "address": "<string>",
                "publicKey": "<string>",
                "network": "<string>"
              }
            ],
            "lastSelectedAt": "2023-11-07T05:31:56Z",
            "verifiedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f",
        "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
        "alias": "An example name",
        "country": "US",
        "email": "[e-mail]",
        "firstName": "An example name",
        "jobTitle": "An example name",
        "lastName": "An example name",
        "phoneNumber": "<string>",
        "policiesConsent": true,
        "tShirtSize": "An example name",
        "team": "An example name",
        "username": "An example name",
        "firstVisit": "2023-11-07T05:31:56Z",
        "lastVisit": "2023-11-07T05:31:56Z",
        "newUser": true,
        "metadata": {},
        "btcWallet": "<string>",
        "kdaWallet": "<string>",
        "ltcWallet": "<string>",
        "ckbWallet": "<string>",
        "kasWallet": "<string>",
        "dogeWallet": "<string>",
        "emailNotification": true,
        "discordNotification": true,
        "newsletterNotification": true,
        "lists": [
          "<string>"
        ],
        "scope": "superuser marketing operations",
        "missingFields": [
          {
            "name": "<string>",
            "required": true,
            "enabled": true,
            "unique": true,
            "verify": true,
            "validationRules": {
              "unique": true,
              "regex": "^0x",
              "validOptions": [
                {
                  "label": "small"
                },
                {
                  "label": "medium"
                },
                {
                  "label": "large"
                }
              ],
              "checkboxText": "Agree to the terms and conditions"
            },
            "label": "<string>",
            "position": 123
          }
        ]
      },
      "conflicts": [
        {
          "field": {
            "name": "<string>",
            "required": true,
            "enabled": true,
            "unique": true,
            "verify": true,
            "validationRules": {
              "unique": true,
              "regex": "^0x",
              "validOptions": [
                {
                  "label": "small"
                },
                {
                  "label": "medium"
                },
                {
                  "label": "large"
                }
              ],
              "checkboxText": "Agree to the terms and conditions"
            },
            "label": "<string>",
            "position": 123
          },
          "fromUser": {
            "userId": "95b11417-f18f-457f-8804-68e361f9164f",
            "value": "An example name"
          },
          "currentUser": {
            "userId": "95b11417-f18f-457f-8804-68e361f9164f",
            "value": "An example name"
          }
        }
      ]
    },
    "additionalMessages": [
      "<string>"
    ]
  }
}

{
  "error": "Internal Server Error"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

customFieldId · string · required

The unique identifier of the custom field to be updated

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

Show child attributes

Response

200

application/json

Custom field updated 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

Show child attributes