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

# Send test email

> Sends a test email with a sample PDF attachment to verify your email configuration. Rate limited to 25 emails per hour per automation.



## OpenAPI

````yaml /openapi.json post /sendTestEmail
openapi: 3.1.0
info:
  title: DocsAutomator API
  version: '2.0'
  description: >-
    REST API for programmatic document generation, automation management, and
    e-signature workflows.
  contact:
    name: DocsAutomator Support
    email: support@docsautomator.co
    url: https://docsautomator.co
servers:
  - url: https://api.docsautomator.co
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Documents
    description: Create documents and manage async jobs
  - name: Automations
    description: CRUD operations for automations
  - name: Templates
    description: Template placeholders and duplication
  - name: E-Signatures
    description: Manage signing sessions, links, and audit trails
  - name: Email
    description: Test email delivery
paths:
  /sendTestEmail:
    post:
      tags:
        - Email
      summary: Send test email
      description: >-
        Sends a test email with a sample PDF attachment to verify your email
        configuration. Rate limited to 25 emails per hour per automation.
      operationId: sendTestEmail
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - automationId
                - recipient
              properties:
                automationId:
                  type: string
                  description: The automation ID.
                recipient:
                  type: string
                  format: email
                  description: Email address to send the test to.
            example:
              automationId: abc123
              recipient: test@example.com
      responses:
        '200':
          description: Test email sent
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Test email sent successfully to test@example.com
                  rateLimit:
                    type: object
                    properties:
                      remaining:
                        type: integer
                        description: Remaining test emails this hour.
                      resetAt:
                        type: string
                        format: date-time
                        description: When the rate limit resets.
        '400':
          $ref: '#/components/responses/BadRequest'
        '429':
          description: Rate limit exceeded (25 per hour per automation)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Missing required parameter
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key from your workspace settings. Pass as `Authorization: Bearer
        <key>` or `X-API-Key: <key>`. Find it at
        [app.docsautomator.co/settings/workspace/api](https://app.docsautomator.co/settings/workspace/api).

````