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

# Invite member



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/workspaces/{workspaceId}/members
openapi: 3.1.0
info:
  title: Optareach Public API
  version: 1.0.0
  description: >-
    Platform-first API surface for accounts, prospects, campaigns, inbox,
    tracked searches, AI rooms, jobs, workspaces, analytics, billing, profile,
    and knowledge bases.
servers:
  - url: /
    description: Current environment
security: []
tags:
  - name: Meta
    description: API metadata and discovery
  - name: Platforms
    description: Platform registry and capabilities
  - name: Accounts
    description: Connected sender accounts
  - name: Prospects
    description: Prospect lists and leads
  - name: Campaigns
    description: Campaign lifecycle and performance
  - name: Inbox
    description: Conversations and messages
  - name: TrackedSearches
    description: Mentions and tracked search streams
  - name: AI
    description: AI chat rooms and enrichment
  - name: Jobs
    description: Background jobs
  - name: Workspaces
    description: Workspace management
  - name: KnowledgeBases
    description: Knowledge base management
  - name: Analytics
    description: Global dashboard metrics
  - name: Billing
    description: Subscriptions and credits
  - name: Profile
    description: Current user profile
  - name: Tags
    description: Conversation tags
  - name: Notifications
    description: Notification feed
paths:
  /api/v1/workspaces/{workspaceId}/members:
    post:
      tags:
        - Workspaces
      summary: Invite member
      parameters:
        - $ref: '#/components/parameters/workspaceId'
      requestBody:
        description: Workspace invitation payload
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InviteMemberRequest'
            example:
              email: ops@acme.com
              role: admin
      responses:
        '200':
          description: Invite result
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WorkspaceMember'
                required:
                  - data
              example:
                data:
                  id: invite_ops_1
                  email: ops@acme.com
                  fullName: Alex Ops
                  role: admin
                  status: invited
components:
  parameters:
    workspaceId:
      name: workspaceId
      in: path
      required: true
      schema:
        type: string
  schemas:
    InviteMemberRequest:
      type: object
      properties:
        email:
          type: string
          format: email
        role:
          type: string
      required:
        - email
        - role
    WorkspaceMember:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
          format: email
        fullName:
          type: string
        role:
          type: string
        status:
          type: string
      required:
        - id
        - email
        - role
        - status

````