Skip to main content

​
Endpoint

POST /clients/members

​
Headers

​
Authorization
string
required
Bearer YOUR_ACCESS_TOKEN
​
SECRET_KEY
string
required
Your API secret key.
​
businessId
string
required
The ID of the business you are inviting the member to.

​
Request body

​
email
string
required
The email address of the person you want to invite. An invitation will be sent to this address with a registration link.
​
memberRoleId
string
required
The ID of the role to assign to the new member. Retrieve available role IDs from GET /clients/members/roles.

​
Response

Returns 201 Created on success.
​
status
boolean
true on success.
​
message
string
Confirmation message, e.g. "Invitation sent successfully".

​
Code examples

curl -X POST https://sandbox.stellasbank.com/api/v1/clients/members \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "newmember@example.com",
    "memberRoleId": "role_abc123"
  }'

​
Example response

{
  "status": true,
  "message": "Invitation sent successfully"
}