> ## 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.

# View email manager



## OpenAPI

````yaml post /admin/email_manager
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/email_manager:
    post:
      tags:
        - Communications
      summary: View email manager
      operationId: 1d9fef18d15290b3832752bcefcdc157
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                client_id:
                  type: string
                  example: '1'
                category:
                  type: string
                  example: message-manager
                page:
                  type: integer
                  example: 1
                perpage:
                  type: integer
                  example: 10
                permissions:
                  type: object
                  example:
                    id: 301
                    deleted_at: null
                    created_at: '2017-02-22T20:40:21.000000Z'
                    updated_at: '2023-05-03T09:41:45.000000Z'
                    client_id: '207'
                    __hevo__ingested_at: 1679725257548
                    __hevo__marked_deleted: 0
                    __hevo__source_modified_at: null
                    __hevo__database_name: apphys_new
                    group_all: '1'
                    account: '1'
                    groups: '1'
                    group-301: '1'
                    admins: '1'
                    forms: '1'
                    new_form: '1'
                    manage_programs: '1'
                    manage_settings: '1'
                    manage_designations: '1'
                    manage_email: '1'
                    email_manager: '1'
                    donations: '1'
                    form_report: '1'
                    program-1221: '1'
                    program-929: '1'
                    donor-639: '1'
                    program-all: '1'
                    donor-all: '1'
                    program-3437: '1'
                    program-3438: '1'
                    program-3439: '1'
                    program-3440: '1'
                    program-3441: '1'
                    program-3442: '1'
                    program-3443: '1'
                    program-3494: '1'
                    program-3495: '1'
                    program-3506: '1'
                    program-3507: '1'
                    disable_entity_archive: '1'
                    disable_donor_archive: null
                    disable_donor_delete: null
                    disable_donor_restore: null
                    disable_entity_delete: null
                    disable_entity_restore: null
                    group_id: 301
                    program-3510: '1'
                    program-3515: '1'
                    program-3516: '1'
                    program-3517: '1'
                    program-3518: '1'
                    disable_message_send_without_approval: null
                    donor-3030: '1'
                    donor-3040: '1'
                    group-1472: '1'
                    group-1473: '1'
                    group-1474: '1'
                    group-1475: '1'
                    program-3539: '1'
                    program-3540: '1'
              type: object
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                properties:
                  emails:
                    description: The list of emails
                    type: array
                    items:
                      properties:
                        id:
                          description: The id of the email
                          type: integer
                        status:
                          description: The status of the email
                          type: integer
                        to:
                          description: The recipient of the email
                          type: string
                        from:
                          description: The sender of the email
                          type: string
                        subject:
                          description: The subject of the email
                          type: string
                        message:
                          description: The message of the email
                          type: string
                        date:
                          description: The date of the email
                          type: string
                      type: object
                  number:
                    description: The total number of emails
                    type: integer
                  a_emails:
                    description: The list of emails assigned to the admin
                    type: array
                    items:
                      properties:
                        id:
                          description: The id of the email
                          type: integer
                        status:
                          description: The status of the email
                          type: integer
                        to:
                          description: The recipient of the email
                          type: string
                        from:
                          description: The sender of the email
                          type: string
                        subject:
                          description: The subject of the email
                          type: string
                        message:
                          description: The message of the email
                          type: string
                        date:
                          description: The date of the email
                          type: string
                      type: object
                  perpage:
                    description: The number of emails per page
                    type: integer
                type: object
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  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.