> ## Documentation Index > Fetch the complete documentation index at: https://docs.heliyos.ai/llms.txt > Use this file to discover all available pages before exploring further. # 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. > [!WARNING] > > 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. > [!NOTE] > > In the Heliyos MCP server: [`heliyos_team_members_invite`](https://docs.heliyos.ai/mcp/tools/team#heliyos-team-members-invite). ## OpenAPI ````yaml /api-reference/openapi.json post /v1/auth/team-memberships openapi: 3.0.3 info: title: Heliyos API version: 1.0.0 description: >- The REST API for Heliyos, the AI operating system for revenue. Every request is scoped to the workspace that owns the API key. Responses are JSON in a `{ meta, data }` envelope; errors use `{ message, error: { code, message, details } }`. contact: name: Heliyos support email: soham@heliyos.ai url: https://www.heliyos.ai servers: - url: https://api-prod.heliyos.ai description: Production security: - bearerAuth: [] tags: - name: Workspace description: >- The workspace your API key belongs to, and the log of credits it has used. Every other call in this API is scoped to this workspace. - name: Schemas description: >- Objects are your record types: companies, people, deal pipelines and any custom objects you add. Each object has fields, and a field's type decides what its records can hold. - name: Records description: >- Records are the rows of an object (base schema): companies, people, deals and custom objects. A record holds field values keyed by the object's field keys and links to other records. - name: Timeline description: >- The AI-written timeline of a company, person or deal: summary entries Heliyos writes on a schedule. For the exact change history see Activities, and for emails and meetings see Interactions. - name: Activities description: >- The change history of records and tasks: who created, changed or deleted what, and when. People, workers and the system each appear as the actor on the changes they make. - name: Interactions description: >- Email threads and meetings synced from connected mailboxes and calendars, linked to the people and companies they involve. - name: Notes description: >- Free-text notes, optionally linked to records, tasks and interactions. Notes show up on the timeline of every record they are linked to, and workers read them as customer memory. - name: Tasks description: >- Work items for people and workers, optionally linked to records. A task can be assigned to people, to workers, or both, and workers can be started on it directly. - name: Workers and runs description: >- Workers are the AI teammates of your workspace (the API calls them agents). Define what each one does and what starts it, ask Heliyos to do work, and follow every run, its steps and the reviews it waits on. - name: Reviews description: >- Reviews keep the team in control of consequential work. When a worker wants to send an email, change a deal, book a meeting, act in a connected app or needs a person's answer, the action waits as a review until someone approves or rejects it. - name: Scouts description: >- Scouts watch companies and the web for events such as funding rounds, product launches, leadership changes or press coverage, and record each finding as a signal. A workspace Scout defines what to look for; company Scouts are its copies running on individual companies. - name: Signals description: >- Signals are what Scouts find: one event, such as a funding round or a new executive, with a summary, its sources and the company it is about. New signals are unread until you mark them read. - name: Watchlist description: >- The watchlist is the set of companies your workers monitor. Each watched company uses one Watcher from your plan: the workers keep it enriched, pull in its emails and meetings, and run Scouts on it. - name: Knowledge base description: >- What your workers know about the business: the business context, four fixed texts (products, pain points, value proposition, qualification criteria) and any custom entries your team adds. Workers read it on their next run. Files your workers read live under Files, with kind `knowledge_base`. - name: Files description: >- Knowledge base files that workers read, and files attached to records, tasks and other resources. The API calls them attachments. Uploading takes three calls: get an upload URL, send the bytes to it, then create the file. - name: Labels description: >- Label groups that sort your email threads, for example Intent or Pricing questions. Heliyos files each classified thread under a group, and each group holds the more specific labels it brings together. The API calls them classification labels. - name: Team description: >- The people in your workspace and their roles: joined members and pending invitations. Inviting someone sends them an email. - name: Notification settings description: >- Which workspace events send notification emails, how often, and to whom. There is one settings document per workspace, shared by everyone in it. paths: /v1/auth/team-memberships: post: tags: - Team summary: Invite a team member description: >- 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. operationId: createTeamMembership parameters: [] requestBody: required: true content: application/json: schema: type: object properties: email: type: string format: email description: The person's email address. Stored in lower case. example: jordan.lee@example.com roleId: type: string pattern: ^[0-9a-fA-F]{24}$ allOf: - $ref: '#/components/schemas/ObjectId' description: >- The role to give them, from **List roles**. With an API key, the `MEMBER` role's id. required: - email - roleId additionalProperties: false example: email: jordan.lee@example.com roleId: 66a0f1e2d3c4b5a697880a03 responses: '200': description: >- The new membership, with status `SENT`. The invitation link is never returned. content: application/json: schema: type: object required: - meta - data properties: meta: type: object required: - message properties: message: type: string description: A human-readable summary of the result. data: $ref: '#/components/schemas/TeamMembership' example: 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' '400': description: >- VALIDATION_FAILED: `email` is not a valid address, or `roleId` is not a role you can give in this workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: Unauthenticated content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: >- FORBIDDEN_ACTION: an API key invited with a role other than `MEMBER`, or the caller may not grant the owner role. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '409': description: >- CONFLICT: the address already has a pending invitation, or the person is already in the workspace. Nothing is sent. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': description: Rate limited content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: ObjectId: type: string pattern: ^[0-9a-fA-F]{24}$ description: A 24-character hexadecimal id. example: 66f1a8c3e4b0a1b2c3d4e5f6 TeamMembership: type: object description: A person's membership of the workspace, or a pending invitation. properties: _id: allOf: - $ref: '#/components/schemas/ObjectId' description: The membership id. Present in list results. id: allOf: - $ref: '#/components/schemas/ObjectId' description: >- The membership id, the same value as `_id`. Use it to remove the member or change their role. email: type: string format: email description: The address the invitation was sent to, in lower case. roleId: allOf: - $ref: '#/components/schemas/ObjectId' description: The role's id. See **List roles**. roleName: type: string description: >- The role's name: `OWNER`, `ADMIN`, `MEMBER`, or `AGENCY` in an agency workspace. List results only. example: MEMBER organizationId: allOf: - $ref: '#/components/schemas/ObjectId' description: The workspace. userId: allOf: - $ref: '#/components/schemas/ObjectId' description: >- The person's user id. Absent while an invited person has no Heliyos account. firstName: type: string description: >- The person's first name, once they have an account. List results only. lastName: type: string description: >- The person's last name, once they have an account. List results only. pictureUrl: type: string description: The person's profile picture, when they set one. List results only. status: type: string enum: - SENT - ACCEPTED - REGISTERED - REJECTED - REVOKED description: > - `SENT`: invited, not joined yet. The invitation link expires 7 days after it was sent. - `ACCEPTED`: joined by accepting an invitation. - `REGISTERED`: joined by creating the workspace. - `REJECTED`, `REVOKED`: found on older invitations only. example: ACCEPTED expiresOn: allOf: - $ref: '#/components/schemas/Timestamp' description: >- When the invitation link expires. Returned by **Invite a team member** only. onboardingSteps: type: array description: >- The person's onboarding progress in Heliyos. Empty for a new invitation. Returned by **Invite a team member** only. items: type: object properties: name: type: string description: The step's name. isCompleted: type: boolean description: Whether the step is done. isSkipped: type: boolean description: Whether the step was skipped. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' description: When the invitation was sent or the membership was created. updatedAt: $ref: '#/components/schemas/Timestamp' ErrorEnvelope: type: object required: - message - error properties: message: type: string description: Same as error.message. error: type: object required: - code - message properties: code: type: string enum: - VALIDATION_FAILED - UNAUTHENTICATED - FORBIDDEN_ACTION - NOT_FOUND - RATE_LIMITED - CONFLICT - INTERNAL message: type: string details: {} Timestamp: type: string format: date-time description: An ISO 8601 date-time in UTC. example: '2026-11-04T09:30:00.000Z' securitySchemes: bearerAuth: type: http scheme: bearer description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.