> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt > Use this file to discover all available pages before exploring further. # Send a test automated email > Queues an automated email using a tenant-owned commitment and trigger. Tests go only to the authenticated admin, bypass sample donor/form email restrictions, and do not notify the donor. A test can target one donation-type variant; it is sent only when that variant and the standard template are both on, and source details such as the DAF sponsor or IRA custodian use clearly labeled sample values. With `test` false, donor email preferences apply and successful queueing records donor activity. Requires admin API authentication and user permission checks. ## OpenAPI ````yaml post /admin/test_emailset openapi: 3.0.0 info: title: Gratona API description: >- REST API for the Gratona fundraising platform, including donor, donation, sponsorship, program, event, and integration workflows. Endpoints are organized by tag. Most endpoints require either a Passport bearer token or an issued API key — see the Security Schemes section. contact: name: Gratona Engineering url: https://gratona.com email: devs@gratona.com version: 1.0.0 servers: - url: https://api.gratona.com/v1 description: Server Version 1.0.0 security: [] tags: - name: Auth description: >- Login, signup, logout, password reset, and email verification for admin users and donors. - name: Donors description: >- Donor records: CRUD, profile fields, household linkage, search, filters, merge, and duplicate detection. - name: Donations description: >- Individual donation records, recurring commitments, soft credits, refunds, designations, and exports. - name: Sponsorships description: >- Donor-to-entity sponsorship relationships, lifecycle transitions, and sponsorship-specific filters. - name: Entities description: >- Recipient records (children, families, projects, animals, etc.), their status, and entity-level fields. - name: Programs description: >- Program / campaign configuration: hierarchy, settings, and program-level metadata. - name: Forms description: >- Custom form builder (HysForm), form fields, standardized donor fields, and field migrations. - name: Trips description: >- Mission-trip management: trips, participants, budgets, tasks, e-signatures, fundraising milestones, and background checks. - name: Communications description: >- Email templates, SMS, newsletters, donor email manager, and per-donor notes. - name: Payments description: >- Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks). Excludes inbound webhooks — see the Webhooks tag. - name: Reports description: Dashboards, analytics, scheduled reports, and exports. - name: Admin description: >- Client-account administration: users, groups/permissions, settings, integrations, and account lifecycle. - name: Donor Portal description: >- Endpoints consumed by the donor-facing portal (donor login, dashboard, donation history, messages). - name: Recipient Portal description: Endpoints consumed by the recipient-facing portal. - name: Public description: >- Unauthenticated public endpoints: donor signup, public trip pages, peer-to-peer campaigns, public checkout. - name: Webhooks description: >- Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr, DropboxSign). Annotated minimally for reference; payload shapes are owned by the upstream provider. - name: Client description: Client - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Files description: Files - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User paths: /admin/test_emailset: post: tags: - Communications summary: Send a test automated email description: >- Queues an automated email using a tenant-owned commitment and trigger. Tests go only to the authenticated admin, bypass sample donor/form email restrictions, and do not notify the donor. A test can target one donation-type variant; it is sent only when that variant and the standard template are both on, and source details such as the DAF sponsor or IRA custodian use clearly labeled sample values. With `test` false, donor email preferences apply and successful queueing records donor activity. Requires admin API authentication and user permission checks. operationId: d0f33aae5af99376c2e07be415fc4242 requestBody: description: >- Test email payload. The controller validates the commitment, trigger, optional statement year, and optional donor-send flag. required: true content: application/json: schema: required: - commitment_id - trigger properties: commitment_id: description: >- Commitment ID belonging to the authenticated client, used for donor, recipient, designation, and email-set context. type: integer example: 88211 trigger: description: >- Automated email trigger to render and send. Validation rule: `required|string`. type: string example: pay_receipt emailset_id: description: >- Email set being edited. When present it must be the email set the commitment uses, otherwise nothing is sent. Validation rule: `nullable|integer`. type: integer example: 42 nullable: true donation_type: description: >- Template variant to test. Non-default variants are admin tests only and never fall back to the standard template. Defaults to `default`. type: string enum: - default - in_kind - soft_credit - daf - qcd example: qcd nullable: true receipt_context: description: >- Optional giving-source context. Use giving_source=daf and recipient_role=soft_credit for an advisor test; an unchanged Standard Donation copy is skipped. Missing context preserves ordinary Direct soft-credit behavior. properties: giving_source: type: string enum: - direct - daf - qcd example: daf recipient_role: type: string enum: - primary - soft_credit example: soft_credit type: object nullable: true additionalProperties: false year: description: >- Statement year used by the `year_end_statement` trigger. Validation rule: `nullable|integer`; defaults to the current year. type: integer example: 2026 nullable: true test: description: >- When true or omitted, sends to the authenticated admin; when false, sends to the donor and records activity. Validation rule: `nullable|boolean`. type: boolean example: true nullable: true type: object responses: '200': description: Email was queued for the selected recipient. content: application/json: schema: properties: status: type: string example: queued message: description: Queue confirmation, not proof of inbox delivery. type: string example: Test email queued for delivery to admin@example.org. type: object '401': description: Missing or invalid API key or bearer token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '404': description: Client or commitment was not found for the authenticated client. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '422': description: >- Validation failed or no email was queued. Skipped sends return status skipped and a message; validation failures also include field errors. security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: UnauthorizedResponse: title: UnauthorizedResponse description: >- Returned with HTTP 401 when the request lacks a valid Passport bearer token, a valid `X-HYS-API-Key`, or a valid session. The body is the simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`. required: - message - status properties: message: description: >- Always the literal string `Unauthorized` from the `auth.api_or_key` middleware. Login endpoints return `Invalid Credentials` instead. type: string example: Unauthorized status: type: string example: error type: object NotFoundResponse: title: NotFoundResponse description: >- Returned with HTTP 404 when a resource lookup misses (typically because the id doesn't exist OR is scoped to a different `client_id`). Note: many endpoints intentionally collapse 'not found' and 'forbidden' into a single 404 to avoid leaking which records exist in another tenant. required: - message properties: message: description: >- Human-readable message. Often a more specific string like `Donor not found` or `Trip not found`. type: string example: Not Found status: type: string example: error type: object securitySchemes: bearerAuth: type: http description: Passport bearer token authentication for legacy admin sessions. scheme: bearer bearerFormat: JWT apiKeyAuth: type: apiKey description: Gratona API key sent with the compatibility header X-HYS-API-Key. name: X-HYS-API-Key in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.