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

# Send yourself a test of one email

> Sends the email, with this organisation's brand and saved wording and sample values, to the signed-in person's own address and nobody else, with the subject prefixed "Test: ". It is delivered like a real email. No attachment. One test a minute per person (429 `test_send_limit`). API tokens cannot send tests.



## OpenAPI

````yaml /api-reference/specs/notification.json post /organisations/{organisationId}/email-settings/{eventType}/test-sends
openapi: 3.0.1
info:
  title: Email wording API
  description: >-
    The wording of the emails we send for you: payslips, P45s, P60s, pension
    enrolment letters, report-ready and webhook alerts, and, for your whole
    account, the sign-in emails. Set it once for your account, or for one
    organisation; each field falls back on its own to the account's, then the
    standard wording. Report-ready and webhook alerts can be switched off.
    Preview the real email, and go back to any saved version. Your brand,
    statutory content and links always stay.
  version: v1
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/notification-settings
security:
  - X-Auth-Token: []
paths:
  /organisations/{organisationId}/email-settings/{eventType}/test-sends:
    post:
      tags:
        - Organisation emails
      summary: Send yourself a test of one email
      description: >-
        Sends the email, with this organisation's brand and saved wording and
        sample values, to the signed-in person's own address and nobody else,
        with the subject prefixed "Test: ". It is delivered like a real email.
        No attachment. One test a minute per person (429 `test_send_limit`). API
        tokens cannot send tests.
      operationId: SendOrganisationTestEmail
      parameters:
        - name: organisationId
          in: path
          required: true
          schema:
            type: string
          description: >-
            The organisation to act on. It must be the one selected with
            `X-Org-Id`: a request naming two different organisations is refused
            with 403.
        - name: eventType
          in: path
          required: true
          schema:
            type: string
            enum:
              - PayslipGeneratedEvent
              - P45GeneratedEvent
              - P60GeneratedEvent
              - EmployeePensionEnrolmentEvent
              - ReportReadyEvent
              - WebhookEndpointFailingEvent
              - WebhookEndpointDisabledEvent
          description: >-
            The email, by the event name its webhook delivery events carry, as
            listed by the list operation: PayslipGeneratedEvent,
            P45GeneratedEvent, P60GeneratedEvent, EmployeePensionEnrolmentEvent,
            ReportReadyEvent, WebhookEndpointFailingEvent,
            WebhookEndpointDisabledEvent.
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailTestSendResponseResponseBody'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
      security:
        - X-Auth-Token: []
          X-Org-Id: []
components:
  schemas:
    EmailTestSendResponseResponseBody:
      type: object
      required:
        - message
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
        content:
          $ref: '#/components/schemas/EmailTestSendResponseContentResponse'
      additionalProperties: false
    ObjectResponseBody:
      type: object
      required:
        - message
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    MessageWithTokenResponse:
      type: object
      required:
        - text
        - token
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    ValidationIssue:
      type: object
      required:
        - field
        - reason
        - reasonToken
      properties:
        field:
          type: string
        reason:
          type: string
        reasonToken:
          type: string
        reasonTokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    EmailTestSendResponseContentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EmailTestSendResponse'
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssueArgument:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        value: {}
      additionalProperties: false
    EmailTestSendResponse:
      type: object
      required:
        - eventType
        - sentTo
      properties:
        eventType:
          type: string
        sentTo:
          type: string
      additionalProperties: false
    ContentMetadataResponse:
      type: object
      required:
        - dateFormat
        - dateTimeFormat
      properties:
        dateFormat:
          type: string
        dateTimeFormat:
          type: string
        paginationToken:
          type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      description: Your access token (raw token, no Bearer prefix)
      name: X-Auth-Token
      in: header
    X-Org-Id:
      type: apiKey
      description: >-
        The organisation to act on. Required only when your credentials can
        reach more than one organisation; optional for a single organisation.
      name: X-Org-Id
      in: header

````

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