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

# Send yourself a test of a signature

> Mails a test of the signature's draft (what publish would install; its published content when it has no draft) to the caller's own address, with one email's real values and no tracking. No recipient is read from the request. 10 an hour per user.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/signatures/{signature_id}/test_email
openapi: 3.0.1
info:
  title: Scribe Public API
  version: v1
  description: >-
    REST API to manage email signatures, teammates, smart fields, and marketing
    campaigns in your Scribe workspace. Every request uses JSON and is
    authenticated with a workspace API key. Endpoints are versioned under `/v1`,
    for example `https://api.scribe-mail.com/v1/signatures`.
  contact:
    name: Scribe Support
    url: https://help.scribe-mail.com/en
servers:
  - url: https://api.scribe-mail.com
    description: Production
security: []
tags:
  - name: Signatures
    description: >-
      Create, update, publish, and install email signature templates, and
      control which teammates each signature is assigned to.
  - name: Teammates
    description: >-
      Manage the people whose signatures Scribe deploys, and set their smart
      field values.
  - name: Emails
    description: >-
      Manage teammate email addresses, including the aliases that receive a
      signature.
  - name: Smart fields
    description: >-
      Define the dynamic fields, such as job title, phone number, or calendar
      link, that populate signatures.
  - name: Folders
    description: Organize signature templates into folders.
  - name: Assets
    description: >-
      Upload and manage the images and files used across signatures and
      campaigns.
  - name: Marketing campaigns
    description: >-
      Schedule, pause, and resume the promotional banners shown in your team's
      signatures.
  - name: Integrations
    description: >-
      List the directory, HRIS, and email integrations connected to your
      workspace.
  - name: Integration entities
    description: >-
      List the org units and groups from your connected integrations, used to
      target signatures.
  - name: Financial documents
    description: List the invoices and financial documents for your workspace.
paths:
  /v1/signatures/{signature_id}/test_email:
    parameters:
      - name: signature_id
        in: path
        required: true
        schema:
          type: string
    post:
      tags:
        - Signatures
      summary: Send yourself a test of a signature
      description: >-
        Mails a test of the signature's draft (what publish would install; its
        published content when it has no draft) to the caller's own address,
        with one email's real values and no tracking. No recipient is read from
        the request. 10 an hour per user.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/signature_test_email_params'
      responses:
        '202':
          description: 'A signature with no draft: its published content'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/signature_test_email_response'
        '403':
          description: Insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: Another workspace's email
        '422':
          description: A signature with no design
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validation_error_response'
        '429':
          description: Past 10 tests an hour
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      security:
        - ApiKey: []
components:
  schemas:
    signature_test_email_params:
      type: object
      properties:
        email_id:
          type: string
          description: >-
            UUID of the email whose values the test shows (any email of the
            workspace). Defaults to the caller's own address in the workspace.
      additionalProperties: false
      description: >-
        The test always goes to the caller's own address: no recipient is read
        from the request.
    signature_test_email_response:
      type: object
      properties:
        data:
          type: object
          properties:
            signature_id:
              type: string
              description: UUID of the signature tested.
            email_id:
              type: string
              description: UUID of the email whose values the test shows.
            sent_to:
              type: string
              description: 'The caller''s own address: the only one a test goes to.'
            design:
              type: string
              enum:
                - draft
                - published
              description: >-
                What the mail renders: the draft (what publish would install),
                or the published content of a signature with no draft.
            status:
              type: string
              enum:
                - queued
              description: The mail is sent in the background.
          required:
            - signature_id
            - email_id
            - sent_to
            - design
            - status
          additionalProperties: false
      required:
        - data
      additionalProperties: false
    error_response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
          required:
            - type
            - code
            - message
          additionalProperties: false
        remediation:
          type: object
          description: >-
            Optional dashboard hand-off: where to send the user to unblock the
            request (e.g. connect an integration). Present on some 403/409
            responses.
          properties:
            action:
              type: string
              enum:
                - connect_integration
                - manage_in_dashboard
                - upgrade_plan
            dashboard_url:
              type: string
              format: uri
            message:
              type: string
          required:
            - action
            - dashboard_url
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
    validation_error_response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
          required:
            - type
            - code
            - message
          additionalProperties: false
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
              allowed:
                type: array
                description: >-
                  For an enum/const violation: the permitted values for this
                  field. Present only when the list is small enough to inline;
                  for large enums (e.g. icon) see the content schema.
                items: {}
              missing:
                type: array
                description: 'For a missing-required violation: the absent property names.'
                items:
                  type: string
            required:
              - field
              - code
              - message
            additionalProperties: false
      required:
        - error
        - details
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer

````

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