Skip to main content
Use this endpoint to invite a new user to your Shogun Dashboard account. You provide the member’s name, email address, and the role they should be assigned. Shogun sends an invitation email containing a link for the new member to set their password and activate their account.

​
Endpoint

POST /api/v1/auth/web/add_member

​
Authentication

This endpoint requires a valid Dashboard JWT. Pass the token in the Authorization header: 
Authorization: Bearer <access_token>

​
Request Body

​
email
string
required
The email address of the person you are inviting. Must be a valid email format. The invitation is sent to this address.
​
first_name
string
required
The first name of the new team member.
​
last_name
string
required
The last name of the new team member.
​
role_id
string (UUID)
required
The ID of the role to assign to the new member. Use Fetch Roles to retrieve available role IDs.

​
Response

{
  "status": true,
  "response_code": "00",
  "message": "Team member invited successfully",
  "data": {}
}

​
Example

curl -X POST https://baasapi.payrepmfb.com/api/v1/auth/web/add_member \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane.doe@example.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "role_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }'
An invitation email is sent to the provided address immediately after the request succeeds. The link in the email allows the new member to set their password and log in for the first time. If they do not receive the email, use Resend Invite to resend it.