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

# Send email invitations

> Email people an invitation to fill in the form, now or at a scheduled time. When the form is restricted to invitees, each address is also added to its invitee list. Calling this again sends the emails again.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace’s subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](https://apidocs.neetoform.com/api/workspace-subdomain.md).


## OpenAPI

````yaml bundled/share.yaml POST /forms/{form_id}/email_invitations
openapi: 3.0.3
info:
  title: NeetoForm Share APIs
  version: 2.0.0
servers:
  - description: NeetoForm APIs
    url: https://{your-subdomain}.neetoform.com/api/external/v2
    variables:
      your-subdomain:
        default: spinkart
        description: >-
          Replace **spinkart** with your [workspace's
          subdomain](/api/workspace-subdomain).
security: []
tags:
  - name: Share
    description: APIs to share a form with links, embed codes and email invitations.
paths:
  /forms/{form_id}/email_invitations:
    post:
      tags:
        - Share
      summary: Send email invitations
      description: >-
        Email people an invitation to fill in the form, now or at a scheduled
        time. When the form is restricted to invitees, each address is also
        added to its invitee list. Calling this again sends the emails again.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
        - $ref: '#/components/parameters/form_id_param'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/email_invitations_request'
      responses:
        '201':
          description: Created - Invitations queued
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_invitations_response'
        '404':
          description: Not Found - Form with the given ID does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
              example:
                error: Form does not exist.
        '422':
          description: >-
            Unprocessable Entity - No emails, an email is not valid, or
            `send_at` is not an ISO 8601 date-time
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
              example:
                error: 'Not a valid email address: oliver@. No invitation was sent'
components:
  parameters:
    api_key_header:
      in: header
      name: X-Api-Key
      description: >-
        Use the X-Api-Key header to provide your workspace API key. Refer to
        [Authentication](/api/authentication) for more information.
      required: true
      schema:
        type: string
        default: your-api-key
    form_id_param:
      in: path
      name: form_id
      description: >-
        Unique ID of the form. Refer to [Getting the Form
        ID](/api/getting-form-id) for detailed instructions.
      required: true
      schema:
        type: string
  schemas:
    email_invitations_request:
      type: object
      properties:
        emails:
          type: array
          description: >-
            Email addresses to invite. Repeated addresses are sent once. If any
            address is not valid, nothing is sent.
          items:
            type: string
            format: email
          example:
            - oliver@example.com
            - sam@example.com
        email_subject:
          type: string
          description: >-
            Subject of the email. Defaults to "Please fill out the <form title>
            form".
          example: Please share your feedback
        email_body:
          type: string
          description: >-
            Body of the email in HTML. Defaults to a short request to fill out
            the form.
          example: <p>Please take a few minutes to share your feedback.</p>
        start_survey_button_text:
          type: string
          description: Text of the button in the email. Defaults to "Get started".
          example: Get started
        reply_to_email:
          type: string
          format: email
          description: Email address that receives replies to the invitation.
          example: support@example.com
        send_from_email:
          type: string
          format: email
          description: Email address the invitation is sent from.
          example: forms@example.com
        send_at:
          type: string
          format: date-time
          description: >-
            Time to send the invitation, in ISO 8601 format. When omitted, the
            invitation is sent now.
          example: '2026-11-01T10:00:00Z'
      required:
        - emails
    email_invitations_response:
      type: object
      properties:
        form_id:
          type: string
          example: 6f1c2a8e-4d1b-4f6e-9a57-2f0f3c1d9b10
        emails:
          type: array
          items:
            type: string
          example:
            - oliver@example.com
            - sam@example.com
        send_at:
          type: string
          format: date-time
          example: '2026-11-01T10:00:00Z'
    error_response:
      type: object
      properties:
        error:
          type: string

````

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