Add a member to a business account

curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/businessAccounts/{businessAccountId}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "cfo",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "identifier": "<string>"
}
'

import requests

url = "https://app.dynamicauth.com/api/v0/environments/{environmentId}/businessAccounts/{businessAccountId}/members"

payload = {
    "role": "cfo",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "identifier": "<string>"
}
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({
    role: 'cfo',
    userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    identifier: '<string>'
  })
};

fetch('https://app.dynamicauth.com/api/v0/environments/{environmentId}/businessAccounts/{businessAccountId}/members', 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}/businessAccounts/{businessAccountId}/members",
  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([
    'role' => 'cfo',
    'userId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'identifier' => '<string>'
  ]),
  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}/businessAccounts/{businessAccountId}/members"

	payload := strings.NewReader("{\n  \"role\": \"cfo\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"identifier\": \"<string>\"\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}/businessAccounts/{businessAccountId}/members")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"role\": \"cfo\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"identifier\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/environments/{environmentId}/businessAccounts/{businessAccountId}/members")

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  \"role\": \"cfo\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"identifier\": \"<string>\"\n}"

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

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "businessAccountId": "95b11417-f18f-457f-8804-68e361f9164f",
  "userId": "95b11417-f18f-457f-8804-68e361f9164f",
  "role": "cfo",
  "email": "<string>",
  "customRole": {
    "name": "cfo",
    "inherits": "cfo"
  },
  "addedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "lastSeenAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "code": "exchange_currency_unsupported"
}

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

{
  "error": "Access Forbidden",
  "code": "sanctions_blocked"
}

{
  "error": "Not Found",
  "code": "not_found"
}

{
  "error": "Conflict: invalid state transition"
}

{
  "error": "Resources already exists for this Object",
  "code": "email_cannot_be_null",
  "payload": {
    "email": "joe@email.com",
    "loginProvider": "emailOnly",
    "embeddedWalletName": "<string>",
    "embeddedSocialSigninProvider": "emailOnly",
    "mergeConflicts": {
      "fromUser": {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
        "verifiedCredentials": [
          {
            "id": "95b11417-f18f-457f-8804-68e361f9164f-zerodev",
            "format": "blockchain",
            "signInEnabled": true,
            "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
            "chain": "<string>",
            "refId": "95b11417-f18f-457f-8804-68e361f9164f",
            "signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
            "email": "jsmith@example.com",
            "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"
            },
            "business_account_properties": {
              "businessAccountId": "95b11417-f18f-457f-8804-68e361f9164f",
              "businessAccountCreatedAt": "2023-11-07T05:31:56Z",
              "businessAccountSignerId": "95b11417-f18f-457f-8804-68e361f9164f",
              "businessAccountSignerType": "endUser",
              "businessAccountMemberRole": "cfo",
              "businessAccountName": "<string>",
              "businessAccountExternalRef": "<string>"
            },
            "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>",
                "network": "<string>"
              }
            ],
            "lastSelectedAt": "2023-11-07T05:31:56Z",
            "verifiedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f-zerodev",
        "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
        "alias": "An example name",
        "country": "US",
        "email": "jsmith@example.com",
        "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
          }
        ]
      },
      "conflicts": [
        {
          "field": {
            "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
          },
          "fromUser": {
            "userId": "95b11417-f18f-457f-8804-68e361f9164f",
            "value": "An example name"
          },
          "currentUser": {
            "userId": "95b11417-f18f-457f-8804-68e361f9164f",
            "value": "An example name"
          }
        }
      ]
    },
    "intent": {},
    "additionalMessages": [
      "<string>"
    ]
  },
  "retryAfterSeconds": 600
}

{
  "error": "Internal Server Error"
}

POST

environments

{environmentId}

businessAccounts

{businessAccountId}

members

Add a member to a business account

curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/businessAccounts/{businessAccountId}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "cfo",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "identifier": "<string>"
}
'

import requests

url = "https://app.dynamicauth.com/api/v0/environments/{environmentId}/businessAccounts/{businessAccountId}/members"

payload = {
    "role": "cfo",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "identifier": "<string>"
}
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({
    role: 'cfo',
    userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    identifier: '<string>'
  })
};

fetch('https://app.dynamicauth.com/api/v0/environments/{environmentId}/businessAccounts/{businessAccountId}/members', 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}/businessAccounts/{businessAccountId}/members",
  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([
    'role' => 'cfo',
    'userId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'identifier' => '<string>'
  ]),
  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}/businessAccounts/{businessAccountId}/members"

	payload := strings.NewReader("{\n  \"role\": \"cfo\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"identifier\": \"<string>\"\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}/businessAccounts/{businessAccountId}/members")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"role\": \"cfo\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"identifier\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/environments/{environmentId}/businessAccounts/{businessAccountId}/members")

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  \"role\": \"cfo\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"identifier\": \"<string>\"\n}"

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

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "businessAccountId": "95b11417-f18f-457f-8804-68e361f9164f",
  "userId": "95b11417-f18f-457f-8804-68e361f9164f",
  "role": "cfo",
  "email": "<string>",
  "customRole": {
    "name": "cfo",
    "inherits": "cfo"
  },
  "addedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "lastSeenAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "code": "exchange_currency_unsupported"
}

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

{
  "error": "Access Forbidden",
  "code": "sanctions_blocked"
}

{
  "error": "Not Found",
  "code": "not_found"
}

{
  "error": "Conflict: invalid state transition"
}

{
  "error": "Resources already exists for this Object",
  "code": "email_cannot_be_null",
  "payload": {
    "email": "joe@email.com",
    "loginProvider": "emailOnly",
    "embeddedWalletName": "<string>",
    "embeddedSocialSigninProvider": "emailOnly",
    "mergeConflicts": {
      "fromUser": {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
        "verifiedCredentials": [
          {
            "id": "95b11417-f18f-457f-8804-68e361f9164f-zerodev",
            "format": "blockchain",
            "signInEnabled": true,
            "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
            "chain": "<string>",
            "refId": "95b11417-f18f-457f-8804-68e361f9164f",
            "signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
            "email": "jsmith@example.com",
            "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"
            },
            "business_account_properties": {
              "businessAccountId": "95b11417-f18f-457f-8804-68e361f9164f",
              "businessAccountCreatedAt": "2023-11-07T05:31:56Z",
              "businessAccountSignerId": "95b11417-f18f-457f-8804-68e361f9164f",
              "businessAccountSignerType": "endUser",
              "businessAccountMemberRole": "cfo",
              "businessAccountName": "<string>",
              "businessAccountExternalRef": "<string>"
            },
            "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>",
                "network": "<string>"
              }
            ],
            "lastSelectedAt": "2023-11-07T05:31:56Z",
            "verifiedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f-zerodev",
        "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
        "alias": "An example name",
        "country": "US",
        "email": "jsmith@example.com",
        "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
          }
        ]
      },
      "conflicts": [
        {
          "field": {
            "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
          },
          "fromUser": {
            "userId": "95b11417-f18f-457f-8804-68e361f9164f",
            "value": "An example name"
          },
          "currentUser": {
            "userId": "95b11417-f18f-457f-8804-68e361f9164f",
            "value": "An example name"
          }
        }
      ]
    },
    "intent": {},
    "additionalMessages": [
      "<string>"
    ]
  },
  "retryAfterSeconds": 600
}

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

businessAccountId

string

required

ID of the business account

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

The user to add as a member and the role to grant them.

role

string

required

A role that can be directly assigned to a member: a built-in (admin, viewer) or a customer-defined role the account has defined. owner is excluded — ownership moves only via transferOwnership. Not an enum, because the set is per-account: a caller can grant any role from GET /roles. Whether the role exists is the enclave's to answer, not this schema's — the pattern only rejects names that could never be one. A role the account has not defined is refused with UNKNOWN_ROLE. A customer-defined role grants exactly what it inherits, so cfo inherits admin is an admin with a distinguishable name. Case-insensitive on input — CFO and cfo name the same role. The server normalizes to lowercase before comparing or storing, so the pattern accepts both cases here even though a held/stored role name (HeldBusinessAccountMemberRole) is always lowercase.

Pattern: ^[a-zA-Z0-9](?:[a-zA-Z0-9_-]{0,30}[a-zA-Z0-9])?$

Example:

"cfo"

userId

string<uuid> | null

identifier

string | null

type

enum<string>

Available options:

email,

id,

externalUserId,

phoneNumber,

socialUsername,

socialAccountId

smsCountryCode

object

Show child attributes

The 'turnkey' value is deprecated and will be removed in a future version.

Available options:

emailOnly,

magicLink,

apple,

bitbucket,

coinbasesocial,

discord,

epicgames,

facebook,

farcaster,

github,

gitlab,

google,

instagram,

linkedin,

microsoft,

twitch,

twitter,

blocto,

banxa,

coinbaseOnramp,

binanceOnramp,

cryptoDotCom,

moonPay,

dynamic,

alchemy,

zerodev,

telegram,

turnkey,

coinbaseWaas,

sms,

spotify,

tiktok,

line,

steam,

shopify,

zksync,

kraken,

blockaid,

passkey,

okta,

sendgrid,

resend,

trmWalletScreening,

chainalysisAddressScreening,

gemini

Response

Member added, or invite sent when member invites are enabled

Option 1
Option 2

The active member when membership is created immediately, or the invite receipt when acceptance is required.

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"

businessAccountId

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"

userId

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"

role

string

required

The role a member actually holds: a built-in (owner, admin, viewer) or a customer-defined role the account has defined. Wider than AssignableBusinessAccountRoleName because a held role can be owner, which cannot be assigned directly.

Pattern: ^[a-z0-9](?:[a-z0-9_-]{0,30}[a-z0-9])?$

Example:

"cfo"

string | null

Member's verified email; null when they have none

customRole

object | null

The member's actual customer-defined role, when role names one; null for a built-in role

Show child attributes

addedByUserId

string<uuid> | null

createdAt

string<date-time>

lastSeenAt

string<date-time> | null

Dashboard-only: this member's most recent session creation time. Null when they have never completed authentication (e.g. still mid-invite).

Overview

Endpoints

Schemas

Add a member to a business account

Authorizations

Path Parameters

Body

Response