Skip to main content
POST
Add a user to a subaccount

Authorizations

Authorization
string
header
required

Your v3 API key, e.g. ask_live_…

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
email
string<email>
required

User email — the login identity.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
password
string
required

Plain password, stored as a bcrypt hash (cost 12) — never persisted in plain text. If the email already belongs to an existing user, that user is linked to the subaccount and this password is IGNORED (an existing password is never changed by this endpoint).

Minimum string length: 8
name
string

Display name. Defaults to the email local-part.

role
enum<string>

Subaccount role. Defaults to MEMBER.

Available options:
OWNER,
ADMIN,
MEMBER,
VIEWER

Response

Success

data
object
required
request_id
string
required
error
null