Skip to main content
PUT
/
sdk
/
{environmentId}
/
users
Update a user's fields
curl --request PUT \
  --url https://app.dynamicauth.com/api/v0/sdk/{environmentId}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "alias": "An example name",
  "firstName": "An example name",
  "lastName": "An example name",
  "jobTitle": "An example name",
  "phoneNumber": "An example name",
  "tShirtSize": "An example name",
  "team": "An example name",
  "policiesConsent": true,
  "country": "US",
  "username": "johndoe",
  "captchaToken": "<string>",
  "metadata": {},
  "mfaBackupCodeAcknowledgement": "pending",
  "btcWallet": "3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5",
  "kdaWallet": "k:0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
  "ltcWallet": "LUttH43tQ4x4qniCKr1Rqo8ESeXFPdv9ax",
  "ckbWallet": "ckt1q9876543210abcdefghijklmnopqrstuvwxyz",
  "kasWallet": "kaspa:qrelgny7sr3vahq69yykxx36m65gvmhryxrlwngfzgu8xkdslum2yxjp3ap8m",
  "dogeWallet": "DPcy35vmuk8GXcfu1vgFFEeij3BuYYJQKB",
  "emailNotification": true,
  "discordNotification": true,
  "newsletterNotification": true
}
'
{
  "user": {
    "id": "95b11417-f18f-457f-8804-68e361f9164f",
    "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
    "verifiedCredentials": [
      {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "format": "blockchain",
        "signInEnabled": true,
        "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
        "chain": "<string>",
        "refId": "95b11417-f18f-457f-8804-68e361f9164f",
        "signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
        "email": "[email protected]",
        "name_service": {
          "avatar": "<string>",
          "name": "<string>"
        },
        "public_identifier": "<string>",
        "wallet_name": "<string>",
        "wallet_provider": "browserExtension",
        "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,
          "version": "V1",
          "ecdsaProviderType": "zerodev_signer_to_ecdsa",
          "entryPointVersion": "v6",
          "kernelVersion": "v2_4"
        },
        "oauth_provider": "emailOnly",
        "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>",
            "type": "ordinals",
            "publicKey": "<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": "[email protected]",
    "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": {},
    "mfaBackupCodeAcknowledgement": "pending",
    "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,
        "type": "standard",
        "validationRules": {
          "unique": true,
          "regex": "^0x",
          "validOptions": [
            {
              "label": "small"
            },
            {
              "label": "medium"
            },
            {
              "label": "large"
            }
          ],
          "checkboxText": "Agree to the terms and conditions"
        },
        "validationType": "text",
        "label": "<string>",
        "position": 123
      }
    ]
  },
  "expiresAt": "1715620310",
  "nextView": "done",
  "mfaToken": "<string>",
  "jwt": "jwt_value",
  "minifiedJwt": "jwt_value"
}

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

User new fields data

​
email
string
Maximum string length: 255
Pattern: ^$|(^([!#-'*+\/-9=?A-Z^-~-]+(\.[!#-'*+\/-9=?A-Z^-~-]+)*|"([]!#-[^-~ \t]|([\t -~]))+")@([!#-'*+\/-9=?A-Z^-~-]+(\.[!#-'*+\/-9=?A-Z^-~-]+)*|[\t -Z^-~]*)$)
Example:

"[email protected]"

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

"An example name"

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

"An example name"

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

"An example name"

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

"An example name"

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

"An example name"

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

"An example name"

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

"An example name"

​
policiesConsent
boolean
​
country
string | null

Standard ISO 3166-1 alpha-2 two-letter country code

Maximum string length: 255
Pattern: ^[A-Z]{2}$
Example:

"US"

​
username
string | null

Alphanumeric with slugs and underscores username

Maximum string length: 255
Pattern: ^$|^[\p{L}\p{N}_-]{3,20}$
Example:

"johndoe"

​
captchaToken
string

When provided, used to verify that a captcha is valid and get the success/failure result from the captcha provider server-side.

​
metadata
object
​
mfaBackupCodeAcknowledgement
enum<string> | null
Available options:
pending,
complete
​
btcWallet
string | null

BTC wallet address

Pattern: ^(bc1|[13])[a-zA-HJ-NP-Z0-9]{25,59}$
Example:

"3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5"

​
kdaWallet
string | null

KDA wallet address

Pattern: ^k:[0-9a-fA-F]{64}$
Example:

"k:0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF"

​
ltcWallet
string | null

LTC wallet address

Pattern: ^[LM3][a-km-zA-HJ-NP-Z1-9]{26,53}$
Example:

"LUttH43tQ4x4qniCKr1Rqo8ESeXFPdv9ax"

​
ckbWallet
string | null

CKB wallet address

Pattern: ^(ckb1q|ckt1q)[0-9a-z]{25,111}$
Example:

"ckt1q9876543210abcdefghijklmnopqrstuvwxyz"

​
kasWallet
string | null

KAS wallet address

Pattern: ^kaspa:[1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz]{56,}$
Example:

"kaspa:qrelgny7sr3vahq69yykxx36m65gvmhryxrlwngfzgu8xkdslum2yxjp3ap8m"

​
dogeWallet
string | null

DOGE wallet address

Pattern: ^D[a-zA-Z0-9_.-]{33}$
Example:

"DPcy35vmuk8GXcfu1vgFFEeij3BuYYJQKB"

​
emailNotification
boolean
​
discordNotification
boolean
​
newsletterNotification
boolean

Response

successful operation - user fields updated

​
user
object
required
​
expiresAt
number
required

Format is a unix-based timestamp. When set, this will be the expiration timestamp on the JWT sent using either the jwt field or a response httpOnly cookie set by the server.

Example:

"1715620310"

​
nextView
enum<string>
required
Available options:
done,
verify-email,
verified-and-transferred,
verify-sms
​
mfaToken
string
​
jwt
string

Encoded JWT token. This will only be returned when cookie-based authentication is disabled in favor of standard Auth header based authentication.

Example:

"jwt_value"

​
minifiedJwt
string

Encoded JWT token. This will only be returned when cookie-based authentication is disabled in favor of standard Auth header based authentication.

Example:

"jwt_value"

​
emailVerification
object
​
smsVerification
object