Skip to main content
POST
/
api
/
v1
/
business
/
members
/
invite
Invite a member to the active business
curl --request POST \
  --url http://localhost:3001/api/v1/business/members/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "teammate@example.com",
  "role": "MEMBER"
}
'
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Axra-Business-Id
string

Active business context

Body

application/json
email
string
required
Example:

"teammate@example.com"

role
enum<string>
required
Available options:
OWNER,
ADMIN,
MEMBER
Example:

"MEMBER"

Response

Bad request

success
boolean
required
Example:

false

error
object
required