Sign in

v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB
SDK

Update a user's fields

put/sdk/{environmentId}/users

Path parameters

environmentIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the environment

Request body

emailstring
aliasstring
firstNamestring
lastNamestring
jobTitlestring
phoneNumberstring
tShirtSizestring
teamstring
policiesConsentboolean
countrystring nullable

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

usernamestring nullable

Alphanumeric with slugs and underscores username

captchaTokenstring

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

metadataobject
mfaBackupCodeAcknowledgement'pending' | 'complete' nullable
btcWalletstring nullable

BTC wallet address

kdaWalletstring nullable

KDA wallet address

ltcWalletstring nullable

LTC wallet address

ckbWalletstring nullable

CKB wallet address

kasWalletstring nullable

KAS wallet address

dogeWalletstring nullable

DOGE wallet address

emailNotificationboolean
discordNotificationboolean
newsletterNotificationboolean

Example request

{
  "email": "hello-world@foobar.com",
  "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",
  "country": "US",
  "username": "johndoe",
  "btcWallet": "3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5",
  "kdaWallet": "k:0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
  "ltcWallet": "LUttH43tQ4x4qniCKr1Rqo8ESeXFPdv9ax",
  "ckbWallet": "ckt1q9876543210abcdefghijklmnopqrstuvwxyz",
  "kasWallet": "kaspa:qrelgny7sr3vahq69yykxx36m65gvmhryxrlwngfzgu8xkdslum2yxjp3ap8m",
  "dogeWallet": "DPcy35vmuk8GXcfu1vgFFEeij3BuYYJQKB"
}

Response

successful operation - user fields updated

mfaTokenstring
jwtstring

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

minifiedJwtstring

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

expiresAtnumber 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.

nextView'done' | 'verify-email' | 'verified-and-transferred' | 'verify-sms' required

Example response

{
  "jwt": "jwt_value",
  "user": {
    "id": "95b11417-f18f-457f-8804-68e361f9164f",
    "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
    "verifiedCredentials": [
      {
        "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
        "refId": "95b11417-f18f-457f-8804-68e361f9164f",
        "signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "wallet_properties": {
          "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f"
        },
        "phoneNumber": "9171113333",
        "phoneCountryCode": "1",
        "isoCountryCode": "US",
        "previous_users": [
          "95b11417-f18f-457f-8804-68e361f9164f"
        ]
      }
    ],
    "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f",
    "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
    "alias": "An example name",
    "country": "US",
    "firstName": "An example name",
    "jobTitle": "An example name",
    "lastName": "An example name",
    "tShirtSize": "An example name",
    "team": "An example name",
    "username": "An example name",
    "scope": "superuser marketing operations",
    "missingFields": [
      {
        "validationRules": {
          "regex": "^0x",
          "validOptions": [
            {
              "label": "small"
            },
            {
              "label": "medium"
            },
            {
              "label": "large"
            }
          ],
          "checkboxText": "Agree to the terms and conditions"
        }
      }
    ]
  },
  "minifiedJwt": "jwt_value",
  "emailVerification": {
    "verificationUUID": "95b11417-f18f-457f-8804-68e361f9164f"
  },
  "smsVerification": {
    "verificationUUID": "95b11417-f18f-457f-8804-68e361f9164f",
    "phoneNumber": "9171113333",
    "phoneCountryCode": "1",
    "isoCountryCode": "US"
  }
}