Guides
API reference
MCP server
ChangelogInvite a team member
curl --request POST \
--url https://api-prod.heliyos.ai/v1/auth/team-memberships \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "jordan.lee@example.com",
"roleId": "66a0f1e2d3c4b5a697880a03"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'jordan.lee@example.com', roleId: '66a0f1e2d3c4b5a697880a03'})
};
fetch('https://api-prod.heliyos.ai/v1/auth/team-memberships', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/auth/team-memberships"
payload = {
"email": "jordan.lee@example.com",
"roleId": "66a0f1e2d3c4b5a697880a03"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"meta": {
"message": "Invitation sent successfully."
},
"data": {
"id": "6729e1f2a3b4c5d6e7f80912",
"email": "jordan.lee@example.com",
"roleId": "66a0f1e2d3c4b5a697880a03",
"organizationId": "66a0f1e2d3c4b5a697887766",
"status": "SENT",
"expiresOn": "2026-11-11T09:30:00.000Z",
"onboardingSteps": [],
"createdAt": "2026-11-04T09:30:00.000Z",
"updatedAt": "2026-11-04T09:30:00.000Z"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}Team
Invite a team member
Invites a person to the workspace with a role and emails them an invitation link. They join when they accept it. The link expires after 7 days; resend an expired invitation from Heliyos under Settings, Team. A person who already has a Heliyos account gets an invitation addressed to them by name.
With an API key you can only invite with the MEMBER role. Get the role’s id from
List roles.
An address with a pending invitation, or of someone already in the workspace, is refused.
POST
/
v1
/
auth
/
team-memberships
Invite a team member
curl --request POST \
--url https://api-prod.heliyos.ai/v1/auth/team-memberships \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "jordan.lee@example.com",
"roleId": "66a0f1e2d3c4b5a697880a03"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'jordan.lee@example.com', roleId: '66a0f1e2d3c4b5a697880a03'})
};
fetch('https://api-prod.heliyos.ai/v1/auth/team-memberships', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/auth/team-memberships"
payload = {
"email": "jordan.lee@example.com",
"roleId": "66a0f1e2d3c4b5a697880a03"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"meta": {
"message": "Invitation sent successfully."
},
"data": {
"id": "6729e1f2a3b4c5d6e7f80912",
"email": "jordan.lee@example.com",
"roleId": "66a0f1e2d3c4b5a697880a03",
"organizationId": "66a0f1e2d3c4b5a697887766",
"status": "SENT",
"expiresOn": "2026-11-11T09:30:00.000Z",
"onboardingSteps": [],
"createdAt": "2026-11-04T09:30:00.000Z",
"updatedAt": "2026-11-04T09:30:00.000Z"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}This sends an invitation email to the address straight away. Check the address, and check
List team members first so you do not invite someone twice.
In the Heliyos MCP server:
heliyos_team_members_invite.Authorizations
A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.
Body
application/json
Was this page helpful?