> ## Documentation Index
> Fetch the complete documentation index at: https://docs.opennous.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Invite a member

> Invite someone to the team by email. Admin keys only. The invitation expires in 7 days.

Sends an invitation by email. Admin keys only. A member key returns `403 admin_key_required`.

When the email does not send, the response still has `invite_link` to share yourself.


## OpenAPI

````yaml POST /v2/members
openapi: 3.1.0
info:
  title: OpenNous REST API
  version: 2.0.0
  description: >-
    Read and write the OpenNous revenue context graph over HTTP. Authenticate
    with a workspace API key.
servers:
  - url: https://api.opennous.cloud
    description: OpenNous Cloud
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: People
  - name: Accounts
  - name: Deals
  - name: Notes
  - name: Attention
  - name: Insights
  - name: Enrich & score
  - name: Organization
  - name: Workflows
  - name: Webhooks
    description: >-
      Subscribe to events and have them pushed to your own stack, with the
      account record attached.
  - name: Usage
paths:
  /v2/members:
    post:
      tags:
        - Organization
      summary: Invite a member
      description: >-
        Invite someone to the team by email. Admin keys only. The invitation
        expires in 7 days.
      operationId: inviteMember
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - email
              properties:
                email:
                  type: string
                  format: email
                role:
                  type: string
                  enum:
                    - admin
                    - member
                    - viewer
                  default: member
            example:
              email: sam@yourco.com
              role: member
      responses:
        '201':
          description: The invitation.
          content:
            application/json:
              schema:
                type: object
                properties:
                  invitation:
                    type: object
                    properties:
                      id:
                        type: string
                      email:
                        type: string
                      role:
                        type: string
                      status:
                        type: string
                      expires_at:
                        type: string
                      created_at:
                        type: string
                  email_sent:
                    type: boolean
                  invite_link:
                    type:
                      - string
                      - 'null'
                  email_error:
                    type: string
                    description: >-
                      Present when the email did not send. Share `invite_link`
                      instead.
              example:
                invitation:
                  id: i1
                  email: sam@yourco.com
                  role: member
                  status: pending
                  expires_at: '2026-10-07T10:00:00Z'
                  created_at: '2026-09-30T10:00:00Z'
                email_sent: true
                invite_link: https://app.opennous.cloud/invite/...
        '400':
          description: Bad email or role, or already invited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                email_required:
                  summary: email_required
                  value:
                    error: email_required
                invalid_email_format:
                  summary: invalid_email_format
                  value:
                    error: invalid_email_format
                invalid_role:
                  summary: invalid_role
                  value:
                    error: invalid_role
                    supported:
                      - admin
                      - member
                      - viewer
                invitation_already_exists:
                  summary: invitation_already_exists
                  value:
                    error: invitation_already_exists
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          description: The plan has no room for another seat.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                seat_limit_reached:
                  summary: seat_limit_reached
                  value:
                    error: seat_limit_reached
                invite_requires_team_plan:
                  summary: invite_requires_team_plan
                  value:
                    error: invite_requires_team_plan
        '403':
          description: Not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                admin_key_required:
                  summary: admin_key_required
                  value:
                    error: admin_key_required
                insufficient_permissions:
                  summary: insufficient_permissions
                  value:
                    error: insufficient_permissions
                read_only_key:
                  summary: read_only_key
                  value:
                    error: read_only_key
        '409':
          description: The workspace has no owner to send from.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: no_team_owner
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    Error:
      type: object
      description: >-
        Every error response. `error` is a stable machine code. Some errors add
        fields such as `detail`, `supported`, `max`, or `reason`.
      required:
        - error
      properties:
        error:
          type: string
          description: Machine-readable error code.
        detail:
          type: string
          description: Human-readable explanation, when there is one.
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, unknown, or expired API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing:
              summary: api_key_required
              value:
                error: api_key_required
            invalid:
              summary: invalid_api_key
              value:
                error: invalid_api_key
            expired:
              summary: api_key_expired
              value:
                error: api_key_expired
                detail: >-
                  This API key has expired. Create or rotate a key to get a
                  fresh one.
    RateLimited:
      description: More than 600 requests in a minute on this key.
      headers:
        RateLimit-Limit:
          schema:
            type: integer
          description: Requests allowed per window.
        RateLimit-Remaining:
          schema:
            type: integer
          description: Requests left in the window.
        RateLimit-Reset:
          schema:
            type: integer
          description: Seconds until the window resets.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: rate_limited
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: internal_error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Workspace API key. Create one in **Settings → API keys**.
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: The same key, sent as a header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.