Skip to main content
POST
SDK — add a member to a business account

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

SDK addMember body. Caller resolves the target user by either passing userId directly OR by identifier + type (email / externalUserId / id), mirroring the pregen flow.

role
enum<string>
required

Business account member role that can be directly assigned. Owner is excluded — ownership moves only via transferOwnership.

Available options:
admin,
viewer
userId
string<uuid> | null
identifier
string | null
type
enum<string>
Available options:
email,
id,
externalUserId,
phoneNumber,
socialUsername,
socialAccountId

Response

Target user was already a member; existing row returned

Admin-reach membership in a business account

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"

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
enum<string>
required

Role of a business account member (admin reach)

Available options:
owner,
admin,
viewer
addedByUserId
string<uuid> | null
createdAt
string<date-time>
Last modified on July 24, 2026