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

# Invite user

> **/auth/invite**

<Note>
  This endpoint requires authentication. Include your Bearer token in the Authorization header.
</Note>

## Description

**/auth/invite**

**Description:**\
Creates or updates an invitation for a workspace member. The endpoint guarantees that a `TenantInvite` record exists so workspace admins can audit, resend, or cancel the invite through `/user/invites`. When an invite is cancelled later, the associated activation link is invalidated automatically.

**Method:**\
`POST`

**Security:**

* Basic Authentication required

**Query Parameters**

| Parameter           | Type   | Description                                         | Required |
| ------------------- | ------ | --------------------------------------------------- | -------- |
| userId *(Optional)* | string | Existing tenant user record to attach to the invite | No       |

**Request Payload:**

| Parameter                | Type    | Description                                            |
| ------------------------ | ------- | ------------------------------------------------------ |
| email                    | string  | Email address to invite.                               |
| sendEmail *(Optional)*   | boolean | Whether to send the invite email (defaults to `true`). |
| message *(Optional)*     | string  | Custom text to include with the invite email.          |
| redirectUrl *(Optional)* | string  | Override activation redirect URL in the invite email.  |

> Invitations are only available to workspace owners or admins. A tenant user can only have one active invitation at a time.

## Code Examples

<CodeGroup>
  ```javascript Node.js theme={null}
  const response = await fetch('https://api.royalti.io/auth/invite', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      "email": "sample-email",
      "sendEmail": true,
      "message": "Welcome to the workspace!",
      "redirectUrl": "https://app.royalti.io/email/activate"
    })
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
    'https://api.royalti.io/auth/invite',
    headers={
      'Authorization': f'Bearer {token}'
    },
    json={"email":"sample-email","sendEmail":true,"message":"Welcome to the workspace!","redirectUrl":"https://app.royalti.io/email/activate"}
  )

  data = response.json()
  print(data)
  ```

  ```bash cURL theme={null}
  curl -X POST https://api.royalti.io/auth/invite \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"email":"sample-email","sendEmail":true,"message":"Welcome to the workspace!","redirectUrl":"https://app.royalti.io/email/activate"}'

  ```
</CodeGroup>


## OpenAPI

````yaml post /auth/invite
openapi: 3.0.0
info:
  title: Royalti.io API
  description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
  version: 2.6.0
  contact:
    name: Royalti.io Support
    email: support@royalti.io
    url: https://royalti.io
  license:
    name: Proprietary
    url: https://royalti.io/terms
servers:
  - url: https://api.royalti.io
    description: Production server
  - url: https://api-dev.royalti.io
    description: Development server
  - url: http://localhost:8084
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Accounting
    description: Accounting and financial transaction operations
  - name: DDEX
    description: DDEX operations (ERN/MEAD, messages, delivery, providers)
  - name: Label
    description: Label management operations
  - name: Internal Webhooks
    description: Internal system webhooks for royalty processing and downloads
  - name: Payment Webhooks
    description: Payment processor webhook endpoints
  - name: Billing Webhooks
    description: Stripe billing and subscription webhooks
  - name: Infrastructure Webhooks
    description: Cloudflare domain and SSL webhooks
  - name: Distribution Webhooks
    description: Digital distribution platform webhooks (FUGA)
paths:
  /auth/invite:
    post:
      tags:
        - Auth
      summary: Invite user
      description: >-
        **/auth/invite**


        **Description:**  

        Creates or updates an invitation for a workspace member. The endpoint
        guarantees that a `TenantInvite` record exists so workspace admins can
        audit, resend, or cancel the invite through `/user/invites`. When an
        invite is cancelled later, the associated activation link is invalidated
        automatically.


        **Method:**  

        `POST`


        **Security:**

        - Basic Authentication required


        **Query Parameters**


        | Parameter | Type | Description | Required |

        | --- | --- | --- | --- |

        | userId _(Optional)_ | string | Existing tenant user record to attach
        to the invite | No |


        **Request Payload:**


        | Parameter | Type | Description |

        | --- | --- | --- |

        | email | string | Email address to invite. |

        | sendEmail _(Optional)_ | boolean | Whether to send the invite email
        (defaults to `true`). |

        | message _(Optional)_ | string | Custom text to include with the invite
        email. |

        | redirectUrl _(Optional)_ | string | Override activation redirect URL
        in the invite email. |


        > Invitations are only available to workspace owners or admins. A tenant
        user can only have one active invitation at a time.
      parameters:
        - name: userId
          in: query
          required: false
          description: The tenant user record to associate with the invite
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  format: email
                  description: The email address of the user to be invited
                sendEmail:
                  type: boolean
                  description: Whether to email the invitation (defaults to true)
                  default: true
                message:
                  type: string
                  description: Custom message that will be included in the invite email
                  example: Welcome to the workspace!
                redirectUrl:
                  type: string
                  description: URL override for the activation link in the invite email
                  example: https://app.royalti.io/email/activate
              required:
                - email
      responses:
        '201':
          description: Success - Existing User Invite
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
              example:
                message: >-
                  Successful, Email verification Instructions have been sent to
                  your email
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
              example:
                message: Only workspace owners can invite users
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Authorization header using the Bearer scheme. Format: "Bearer
        {token}"

````