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

> ## Agent Instructions
> Base URL: https://api.social-api.ai/v1. Send your API key in the Authorization header: Authorization: Bearer <your API key>.
> Every error response from /v1 is JSON: { "error": { "code", "message", "meta" (optional) }, "request_id" }. Branch on error.code; use error.message only for logs.
> A 429 response carries a Retry-After header, in seconds, when the limit has a known wait. Authenticated responses can carry X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset for the per-minute request budget your SocialAPI account shares across every API key (see /guides/rate-limits).
> Paginated list endpoints return next_cursor, at the top level or inside pagination (see /guides/pagination). Pass it as the cursor query parameter to get the next page. An absent or empty next_cursor means you have the last page.
> Treat every ID as an opaque string: do not parse it or assume a format.
> Support differs by platform and by operation. Check /platforms/overview before assuming an operation works on a platform. An unsupported operation returns 501 with error.code resource.not_supported.

# Create an invite link

> Creates a single-use invite link for an external user to connect a social account to a brand.
The brand must not already have a connected account for the specified platform, and
no active (unused, unexpired) invite may exist for the same brand+platform combination.



## OpenAPI

````yaml /api-reference/openapi.json post /invites
openapi: 3.0.0
info:
  description: >-
    Unified social media inbox API. Read and respond to comments, DMs, reviews,
    and mentions across Instagram, Facebook, Threads, Google Business Profile,
    TikTok, LinkedIn, and YouTube through a single REST API. X/Twitter and
    Trustpilot coming soon.
  title: SocialAPI.AI
  contact:
    name: SocialAPI.AI Support
    email: support@social-api.ai
  license:
    name: MIT
  version: '1.0'
servers:
  - url: https://api.social-api.ai/v1
security: []
paths:
  /invites:
    post:
      tags:
        - Invites
      summary: Create an invite link
      description: >-
        Creates a single-use invite link for an external user to connect a
        social account to a brand.

        The brand must not already have a connected account for the specified
        platform, and

        no active (unused, unexpired) invite may exist for the same
        brand+platform combination.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api_endpoints.CreateInviteRequest'
        description: Invite details
        required: true
      responses:
        '201':
          description: Invite created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.InviteResponse'
        '400':
          description: >-
            Missing or invalid fields, or invalid permissions
            (validation.permissions_empty, validation.permission_unknown)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.ErrorResponse'
        '404':
          description: Brand not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.ErrorResponse'
        '409':
          description: Account or active invite already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    api_endpoints.CreateInviteRequest:
      type: object
      properties:
        brand_id:
          type: string
          example: b_01HZ9X3Q4R5M6N7P8V2K0W1J
        expires_in_days:
          type: integer
          example: 7
        permissions:
          description: >-
            The permissions the connected account gets, which are the only ones
            the invited person is asked to grant. Omit it to keep the brand's
            current permissions for this platform, or to give every permission
            if it has none. Valid values: posts.read, posts.write,
            comments.read, comments.write, messages.read, messages.write,
            reviews.read, reviews.write, analytics.read.
          type: array
          items:
            type: string
          example:
            - comments.read
            - comments.write
        platform:
          type: string
          example: facebook
    api_endpoints.InviteResponse:
      type: object
      properties:
        expires_at:
          type: string
          example: '2026-04-03T12:00:00Z'
        id:
          type: string
          example: inv_01HZ9X3Q4R5M6N7P8V2K0W1J
        permissions:
          description: >-
            The permissions chosen when the invite was created. null means the
            brand's current permissions for this platform apply when the invite
            is used, or every permission if it has none.
          type: array
          items:
            type: string
          example:
            - comments.read
            - comments.write
        platform:
          type: string
          example: facebook
        token:
          type: string
          example: a55755cf75f73b56deb3dfe0c993fd36fc4c2bfa7
        url:
          type: string
          example: https://api.social-api.ai/invite/a55755cf...
    api_endpoints.ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/api_endpoints.ErrorBody'
        request_id:
          description: >-
            RequestID matches the X-Request-ID response header. Include it when
            contacting support.
          type: string
          example: 01HZ9X3Q4R5M6N7P8V2K0W1J
    api_endpoints.ErrorBody:
      type: object
      properties:
        code:
          type: string
          example: resource.not_found
        message:
          type: string
          example: Account not found
        meta:
          type: object
          additionalProperties: {}
  securitySchemes:
    BearerAuth:
      description: >-
        Prefix your API key with "Bearer ". Example: `Authorization: Bearer
        sapi_key_...`
      type: apiKey
      name: Authorization
      in: header

````

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