Invite a team member
POST /api/v2/users/invites - Creates a pending invite. Email is required. Phone is optional.
POST
/api/v2/users/invitesCreates a pending invite. Email is required. Phone is optional.
Required scope: users (or *).
JSON body
| Name | Required | Description |
|---|---|---|
email | Yes | Invitee email |
role | No | admin or agent (default agent) |
first_name | No | Invitee first name |
last_name | No | Invitee last name |
phone | No | Optional phone number |
Example request
curl -s -X POST -H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"email": "[email protected]",
"role": "agent",
"first_name": "Sam",
"last_name": "Lee",
"phone": "5551112222"
}' \
"https://benefitpath.com/api/v2/users/invites"Example response
{
"success": true,
"invite": {
"email": "[email protected]",
"role": "agent",
"first_name": "Sam",
"last_name": "Lee"
}
}