Skip to content

Invite developer or viewer (owner only)

POST
/dashboard/v1/merchants/{merchantId}/{mode}/members
curl --request POST \
--url http://localhost:4000/dashboard/v1/merchants/example/test/members \
--header 'Content-Type: application/json' \
--cookie better-auth.session_token=<better-auth.session_token> \
--data '{ "email": "[email protected]", "role": "developer" }'
merchantId
required
string
mode
required
string
Allowed values: test live
Media typeapplication/json
object
email
required
string format: email
role
required
string
Allowed values: developer viewer

Member

Media typeapplication/json
object
user_id
required
string
merchant_id
required
string
email
required
string
role
required
string
Allowed values: owner developer viewer
Example
{
"role": "owner"
}

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Sign-in required

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Forbidden

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Idempotency conflict or invalid state

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}