Create global wallet settings for the environment

Creates new global wallet settings for the specified environment.

POST /environments/{environmentId}/globalWallet/settings

Create global wallet settings for the environment

cURL

curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/globalWallet/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "walletName": "An example name",
  "popupPageTitle": "An example name",
  "walletIconUrl": "https://website-sample/icon.svg",
  "customCssUrl": "https://website-sample/custom.css",
  "termsOfServiceUrl": "https://website-sample.com",
  "privacyPolicyUrl": "https://website-sample.com",
  "termsOfServiceAndPrivacyPolicyMarkdown": "This is a markdown example with a **bold** text and a [link](https://website-sample.com)",
  "customMenuLinks": [
    {
      "label": "An example name",
      "url": "https://website-sample.com"
    }
  ],
  "enableLoginWithExternalWallets": true
}
'

import requests

url = "https://app.dynamicauth.com/api/v0/environments/{environmentId}/globalWallet/settings"

payload = {
    "walletName": "An example name",
    "popupPageTitle": "An example name",
    "walletIconUrl": "https://website-sample/icon.svg",
    "customCssUrl": "https://website-sample/custom.css",
    "termsOfServiceUrl": "https://website-sample.com",
    "privacyPolicyUrl": "https://website-sample.com",
    "termsOfServiceAndPrivacyPolicyMarkdown": "This is a markdown example with a **bold** text and a [link](https://website-sample.com)",
    "customMenuLinks": [
        {
            "label": "An example name",
            "url": "https://website-sample.com"
        }
    ],
    "enableLoginWithExternalWallets": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    walletName: 'An example name',
    popupPageTitle: 'An example name',
    walletIconUrl: 'https://website-sample/icon.svg',
    customCssUrl: 'https://website-sample/custom.css',
    termsOfServiceUrl: 'https://website-sample.com',
    privacyPolicyUrl: 'https://website-sample.com',
    termsOfServiceAndPrivacyPolicyMarkdown: 'This is a markdown example with a **bold** text and a [link](https://website-sample.com)',
    customMenuLinks: [{label: 'An example name', url: 'https://website-sample.com'}],
    enableLoginWithExternalWallets: true
  })
};

fetch('https://app.dynamicauth.com/api/v0/environments/{environmentId}/globalWallet/settings', 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/environments/{environmentId}/globalWallet/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'walletName' => 'An example name',
    'popupPageTitle' => 'An example name',
    'walletIconUrl' => 'https://website-sample/icon.svg',
    'customCssUrl' => 'https://website-sample/custom.css',
    'termsOfServiceUrl' => 'https://website-sample.com',
    'privacyPolicyUrl' => 'https://website-sample.com',
    'termsOfServiceAndPrivacyPolicyMarkdown' => 'This is a markdown example with a **bold** text and a [link](https://website-sample.com)',
    'customMenuLinks' => [
        [
                'label' => 'An example name',
                'url' => 'https://website-sample.com'
        ]
    ],
    'enableLoginWithExternalWallets' => true
  ]),
  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/environments/{environmentId}/globalWallet/settings"

	payload := strings.NewReader("{\n  \"walletName\": \"An example name\",\n  \"popupPageTitle\": \"An example name\",\n  \"walletIconUrl\": \"https://website-sample/icon.svg\",\n  \"customCssUrl\": \"https://website-sample/custom.css\",\n  \"termsOfServiceUrl\": \"https://website-sample.com\",\n  \"privacyPolicyUrl\": \"https://website-sample.com\",\n  \"termsOfServiceAndPrivacyPolicyMarkdown\": \"This is a markdown example with a **bold** text and a [link](https://website-sample.com)\",\n  \"customMenuLinks\": [\n    {\n      \"label\": \"An example name\",\n      \"url\": \"https://website-sample.com\"\n    }\n  ],\n  \"enableLoginWithExternalWallets\": true\n}")

	req, _ := http.NewRequest("POST", 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.post("https://app.dynamicauth.com/api/v0/environments/{environmentId}/globalWallet/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"walletName\": \"An example name\",\n  \"popupPageTitle\": \"An example name\",\n  \"walletIconUrl\": \"https://website-sample/icon.svg\",\n  \"customCssUrl\": \"https://website-sample/custom.css\",\n  \"termsOfServiceUrl\": \"https://website-sample.com\",\n  \"privacyPolicyUrl\": \"https://website-sample.com\",\n  \"termsOfServiceAndPrivacyPolicyMarkdown\": \"This is a markdown example with a **bold** text and a [link](https://website-sample.com)\",\n  \"customMenuLinks\": [\n    {\n      \"label\": \"An example name\",\n      \"url\": \"https://website-sample.com\"\n    }\n  ],\n  \"enableLoginWithExternalWallets\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/environments/{environmentId}/globalWallet/settings")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"walletName\": \"An example name\",\n  \"popupPageTitle\": \"An example name\",\n  \"walletIconUrl\": \"https://website-sample/icon.svg\",\n  \"customCssUrl\": \"https://website-sample/custom.css\",\n  \"termsOfServiceUrl\": \"https://website-sample.com\",\n  \"privacyPolicyUrl\": \"https://website-sample.com\",\n  \"termsOfServiceAndPrivacyPolicyMarkdown\": \"This is a markdown example with a **bold** text and a [link](https://website-sample.com)\",\n  \"customMenuLinks\": [\n    {\n      \"label\": \"An example name\",\n      \"url\": \"https://website-sample.com\"\n    }\n  ],\n  \"enableLoginWithExternalWallets\": true\n}"

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

201

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "walletName": "An example name",
  "popupPageTitle": "An example name",
  "walletIconUrl": "https://website-sample/icon.svg",
  "customCssUrl": "https://website-sample/custom.css",
  "termsOfServiceUrl": "https://website-sample.com",
  "privacyPolicyUrl": "https://website-sample.com",
  "termsOfServiceAndPrivacyPolicyMarkdown": "This is a markdown example with a **bold** text and a [link](https://website-sample.com)",
  "customMenuLinks": [
    {
      "label": "An example name",
      "url": "https://website-sample.com"
    }
  ],
  "enableLoginWithExternalWallets": true,
  "enabledAt": "2023-11-07T05:31:56Z"
}

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

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

walletName · string · required

Maximum string length: 50

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

Example:

"An example name"

popupPageTitle · string

Maximum string length: 50

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

Example:

"An example name"

walletIconUrl · string

Pattern: ^$|^(https?:\/\/)?[a-z0-9]+([-.]+[a-z0-9]+)*\.[a-z]{2,10}([0-9]{1,5})?(\/[^\/]*)*\/[^\/]*\.(?:png|svg)$

Example:

"https://website-sample/icon.svg"

customCssUrl · string

Pattern: ^$|^(https?:\/\/)?[a-z0-9]+([-.]+[a-z0-9]+)*\.[a-z]{2,10}([0-9]{1,5})?(\/[^\/]*)*\/[^\/]*\.css$

Example:

"https://website-sample/custom.css"

termsOfServiceUrl · string

Pattern: ^$|^(https?:\/\/)?[a-z0-9]+([-.]+[a-z0-9]+)*\.[a-z]{2,10}([0-9]{1,5})?(\/.*)?$

Example:

"https://website-sample.com"

privacyPolicyUrl · string

Pattern: ^$|^(https?:\/\/)?[a-z0-9]+([-.]+[a-z0-9]+)*\.[a-z]{2,10}([0-9]{1,5})?(\/.*)?$

Example:

"https://website-sample.com"

termsOfServiceAndPrivacyPolicyMarkdown · string

Maximum string length: 1024

Pattern: ^$|^(?!.*<[^&]+>)[a-zA-Z0-9\s\/;:\*\-\(\)\[\]%#@'"\\.,=+\$&]+$

Example:

"This is a markdown example with a **bold** text and a [link](https://website-sample.com)"

customMenuLinks · object[]

Array of {label, url} objects that add custom navigation links to the wallet menu

Show child attributes

enableLoginWithExternalWallets · boolean

When true, users can also log in with external wallets (MetaMask, WalletConnect, etc.)

Response

201

application/json

Successfully created global wallet settings for this environment

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"

walletName · string · required

Maximum string length: 50

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

Example:

"An example name"

popupPageTitle · string

Maximum string length: 50

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

Example:

"An example name"

walletIconUrl · string

Pattern: ^$|^(https?:\/\/)?[a-z0-9]+([-.]+[a-z0-9]+)*\.[a-z]{2,10}([0-9]{1,5})?(\/[^\/]*)*\/[^\/]*\.(?:png|svg)$

Example:

"https://website-sample/icon.svg"

customCssUrl · string

Pattern: ^$|^(https?:\/\/)?[a-z0-9]+([-.]+[a-z0-9]+)*\.[a-z]{2,10}([0-9]{1,5})?(\/[^\/]*)*\/[^\/]*\.css$

Example:

"https://website-sample/custom.css"

termsOfServiceUrl · string

Pattern: ^$|^(https?:\/\/)?[a-z0-9]+([-.]+[a-z0-9]+)*\.[a-z]{2,10}([0-9]{1,5})?(\/.*)?$

Example:

"https://website-sample.com"

privacyPolicyUrl · string

Pattern: ^$|^(https?:\/\/)?[a-z0-9]+([-.]+[a-z0-9]+)*\.[a-z]{2,10}([0-9]{1,5})?(\/.*)?$

Example:

"https://website-sample.com"

termsOfServiceAndPrivacyPolicyMarkdown · string

Maximum string length: 1024

Pattern: ^$|^(?!.*<[^&]+>)[a-zA-Z0-9\s\/;:\*\-\(\)\[\]%#@'"\\.,=+\$&]+$

Example:

"This is a markdown example with a **bold** text and a [link](https://website-sample.com)"

customMenuLinks · object[]

List of custom menu links displayed in the global wallet

Show child attributes

enableLoginWithExternalWallets · boolean

Whether users can log in using external (non-embedded) wallets

enabledAt · string<date-time> | null

If global wallet is enabled, then this timestamp will be present.