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

# Send test email

> Requires `write:campaigns`. One-off test email (`to`, `subject`, `html`). Does not publish a campaign. `to` must be a team member or customer email for this facility.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/marketing/campaigns/test/email
openapi: 3.0.0
info:
  title: Car Storage Software API
  version: 1.1.0
  description: >-
    Team-scoped REST API for Car Storage Software. Authenticate with a team API
    key (`Authorization: Bearer <key>` or `x-api-key: <key>`) created under
    Settings → Integrations → API. Keys carry granular `read:*` / `write:*`
    scopes; read never implies write.
servers:
  - url: https://www.carstoragesoftware.com
security: []
paths:
  /api/v1/marketing/campaigns/test/email:
    post:
      tags:
        - Marketing
      summary: Send test email
      description: >-
        Requires `write:campaigns`. One-off test email (`to`, `subject`,
        `html`). Does not publish a campaign. `to` must be a team member or
        customer email for this facility.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1CampaignTestEmail'
      responses:
        '200':
          description: Sent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1CampaignTestEmailResult'
        '401':
          description: Missing, invalid, revoked, or expired API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: API key missing required scope, or API disabled for team.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    V1CampaignTestEmail:
      type: object
      properties:
        to:
          type: string
          format: email
        subject:
          type: string
          minLength: 1
        html:
          type: string
          minLength: 1
      required:
        - to
        - subject
        - html
    V1CampaignTestEmailResult:
      type: object
      properties:
        data:
          type: object
          properties:
            success:
              type: boolean
              enum:
                - true
            email:
              type: string
              format: email
          required:
            - success
            - email
      required:
        - data
    ApiError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
        details:
          nullable: true
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Team API key from Settings → Integrations. Use `Authorization: Bearer
        <key>` or `x-api-key`.

````

## Related topics

- [Send test SMS](/docs/api-reference/marketing/send-test-sms.md)
- [Send test push notification](/docs/api-reference/marketing/send-test-push-notification.md)
- [Send an email from Inbox](/docs/inbox/send-an-email-from-inbox.md)
- [Schedule a service while signing a contract](/docs/contracts/schedule-a-service-while-signing-a-contract.md)
- [Send and collect customer payments](/docs/payments/send-and-collect-customer-payments.md)


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