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

# Refresh a saved tag newsletter audience

> Rebuilds the saved ANY-tag snapshot from current tenant donors, preserving explicit additions and manual removals. Only editable draft/future scheduled newsletters with saved tags can refresh. Does not dispatch email; returns refreshed detail and first50 recipient ids. Requires permission: one of newsletter.



## OpenAPI

````yaml post /admin/newsLetters/{id}/audience/refresh
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 commitment relationships, lifecycle transitions, and
      commitment-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: Events
    description: >-
      Event setup, invitations, registration, ticketing, attendance and event
      reporting.
  - name: Journeys
    description: >-
      Journey graphs, activation, enrollment, message templates and event
      follow-up automations.
  - name: Tasks
    description: Workspace tasks, assignments, saved task views and record collaboration.
  - name: Fundraising
    description: >-
      Fundraising portfolios, stewardship plans, giving anniversaries and
      personal donor follow-up.
  - name: Impact Stories
    description: Story intake, review, assets, consent and publication workflows.
  - name: Integrations
    description: Workspace integration connections, mappings, synchronization and recovery.
  - name: Email Calendar
    description: Connected email/calendar accounts and donor interactions.
  - name: Spaces
    description: Workspace Spaces and collaborative Pages.
  - name: Library
    description: Workspace documents, source connections, files and analysis.
  - name: Intelligence
    description: Donor intelligence and Tali workspace workflows.
  - name: Automation
    description: >-
      V3 automation primitive discovery, input validation, invocation and Zapier
      contracts.
  - name: Schema
    description: V3 model, enum, capability and scope discovery.
  - name: Zapier
    description: Zapier automation connections, polling feeds and actions.
  - name: Files
    description: Files
  - name: Client
    description: Client
  - name: Payment Gateways
    description: Payment Gateways
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Recipients
    description: Recipients
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Settings
    description: Settings
  - name: Notifications
    description: Notifications
  - name: Participation
    description: Participation
  - name: Users
    description: Users
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
  - name: Workspace
    description: Workspace
paths:
  /admin/newsLetters/{id}/audience/refresh:
    post:
      tags:
        - Communications
      summary: Refresh a saved tag newsletter audience
      description: >-
        Rebuilds the saved ANY-tag snapshot from current tenant donors,
        preserving explicit additions and manual removals. Only editable
        draft/future scheduled newsletters with saved tags can refresh. Does not
        dispatch email; returns refreshed detail and first50 recipient ids.
        Requires permission: one of newsletter.
      operationId: communicationsNewsletterRefreshAudience
      parameters:
        - name: id
          in: path
          description: Id in the current organization.
          required: true
          schema:
            type: integer
          example: 42
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationsNewsletterDetail'
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: >-
            The authenticated user lacks access to this workflow or its related
            records.
        '404':
          description: The newsletter is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '409':
          description: The newsletter is no longer editable or already due.
        '422':
          description: No saved tag audience is available to refresh.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestRejection'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    CommunicationsNewsletterDetail:
      description: >-
        Read/edit/audience-save payload. message is included only after
        mutations; detail includes at most the first50 recipient ids.
      properties:
        data:
          allOf:
            - $ref: '#/components/schemas/CommunicationsNewsletterRecord'
            - $ref: '#/components/schemas/CommunicationsNewsletterDeliverySummary'
        donors:
          type: array
          items:
            $ref: '#/components/schemas/CommunicationsNewsletterRecipient'
        recipient_pagination:
          properties:
            current_page:
              type: integer
              example: 1
            per_page:
              type: integer
              example: 1
            total:
              type: integer
              example: 1
            last_page:
              type: integer
              example: 1
          type: object
        audience:
          $ref: '#/components/schemas/CommunicationsNewsletterAudience'
        status:
          type: string
          example: success
        message:
          type: string
          example: Newsletter successfully updated
      type: object
    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
    RequestRejection:
      description: >-
        Request or workflow rejection. Framework field-validation failures
        contain errors; semantic rejections may contain message without errors;
        legacy/provider failures may use error and error_code. The operation
        description identifies the rejected condition. Domain responses may add
        current revision, limits or other conflict context.
      anyOf:
        - $ref: '#/components/schemas/ValidationErrorResponse'
        - $ref: '#/components/schemas/ErrorResponse'
        - required:
            - error
          properties:
            error:
              description: Legacy or provider-facing error message.
              type: string
              example: The request could not be completed.
            error_code:
              description: Stable domain error code, when provided.
              type: string
              example: WORKFLOW_UNAVAILABLE
          type: object
    CommunicationsNewsletterRecord:
      description: >-
        Full stored newsletter without raw donor_ids/donor_emails. Detail adds
        delivery summary; clone does not.
      properties:
        id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        client_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        title:
          type: string
          example: Education field update
        message:
          description: Saved newsletter HTML.
          type: string
          example: <p>Thank you for supporting education.</p>
        design:
          description: Serialized editor design; object input is JSON-encoded.
          type: string
          example: '{`body`:{}}'
          nullable: true
        status:
          type: string
          enum:
            - draft
            - scheduled
            - sending
            - sent
            - failed
            - skipped
          example: draft
        type:
          type: string
          example: newsletter
        sender_email:
          type: string
          format: email
          example: admin@example.org
        sender_name:
          type: string
          example: Jane Admin
        attachment:
          type: string
          example: https://example.org/newsletter.pdf
          nullable: true
        scheduled_at:
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        timezone:
          type: string
          example: Africa/Kampala
          nullable: true
        scheduled_timezone:
          type: string
          example: Africa/Kampala
          nullable: true
        schedule_source:
          type: string
          example: calendar
          nullable: true
        timing_recommendation_id:
          type: string
          example: 550e8400-e29b-41d4-a716-446655440000
          nullable: true
        schedule_claim_id:
          type: string
          example: 550e8400-e29b-41d4-a716-446655440000
          nullable: true
        claimed_at:
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        recipient_count:
          description: Count.
          type: integer
          minimum: 0
          example: 1
        audience_selection:
          description: >-
            Persisted audience explanation; manual selection stores null, all
            mode omits tag-specific fields.
          properties:
            version:
              type: integer
              example: 2
            mode:
              type: string
              enum:
                - all
                - static
              example: static
            captured_at:
              type: string
              format: date-time
              example: '2026-10-20T12:00:00Z'
              nullable: true
            tag_operator:
              type: string
              enum:
                - any
              example: any
            tags:
              type: array
              items:
                type: string
                example: Education
            tag_match_count:
              description: Count.
              type: integer
              minimum: 0
              example: 1
            individual_donor_ids:
              type: array
              items:
                description: Organization-owned record identifier.
                type: integer
                example: 42
                nullable: false
            excluded_tag_donor_ids:
              type: array
              items:
                description: Organization-owned record identifier.
                type: integer
                example: 42
                nullable: false
            recipient_count:
              description: Count.
              type: integer
              minimum: 0
              example: 1
          type: object
          nullable: true
        created_at:
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
      type: object
    CommunicationsNewsletterDeliverySummary:
      description: >-
        Derived delivery results; sent means provider acceptance, separate from
        delivered confirmation.
      properties:
        delivery_status:
          description: >-
            Newsletter composition, saved audiences, scheduling and durable
            delivery results.
          type: string
          enum:
            - draft
            - scheduled
            - sending
            - sent
            - failed
            - skipped
            - partially_sent
            - unconfirmed
          example: partially_sent
        delivery_total:
          description: Count.
          type: integer
          minimum: 0
          example: 1
        delivery_sent:
          description: Count.
          type: integer
          minimum: 0
          example: 1
        delivery_failed:
          description: Count.
          type: integer
          minimum: 0
          example: 1
        delivery_unconfirmed:
          description: Count.
          type: integer
          minimum: 0
          example: 1
        delivery_pending:
          description: Count.
          type: integer
          minimum: 0
          example: 1
        delivery_skipped:
          description: Count.
          type: integer
          minimum: 0
          example: 1
      type: object
    CommunicationsNewsletterRecipient:
      description: >-
        Saved snapshot address with current donor context, including deleted
        donor records; blank addresses are omitted while pagination counts saved
        ids.
      properties:
        email:
          type: string
          format: email
          example: jane@example.org
        current_email:
          type: string
          format: email
          example: jane.new@example.org
          nullable: true
        email_drifted:
          type: boolean
          example: true
        name:
          type: string
          example: Jane Donor
        id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        tags:
          type: string
          example: Education,Monthly
          nullable: true
      type: object
    CommunicationsNewsletterAudience:
      description: >-
        Snapshot-versus-current tag facts. All/manual fresh mode omits tag
        facts; legacy or manual selections can return null.
      properties:
        version:
          type: integer
          example: 2
        mode:
          type: string
          enum:
            - all
            - static
            - manual
          example: static
        captured_at:
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        capture_time_estimated:
          type: boolean
          example: true
        snapshot_recipient_count:
          description: Count.
          type: integer
          minimum: 0
          example: 1
        tag_operator:
          type: string
          enum:
            - any
          example: any
        tags:
          type: array
          items:
            type: string
            example: Education
        tag_match_count_at_capture:
          description: Count.
          type: integer
          minimum: 0
          example: 1
        current_tag_member_count:
          description: Count.
          type: integer
          minimum: 0
          example: 1
        not_included_count:
          description: Count.
          type: integer
          minimum: 0
          example: 1
        manual_exclusion_count:
          description: Count.
          type: integer
          minimum: 0
          example: 1
        new_tag_member_count:
          description: Count.
          type: integer
          minimum: 0
          example: 1
        no_longer_matches_count:
          description: Count.
          type: integer
          minimum: 0
          example: 1
      type: object
      nullable: true
    ValidationErrorResponse:
      title: ValidationErrorResponse
      description: >-
        Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The
        `errors` map is keyed by the failing field name; each value is an array
        of human-readable error messages for that field. Most controllers also
        include a top-level `status: error`.
      required:
        - errors
      properties:
        errors:
          description: >-
            Map of field name to array of validator error messages. Example:
            `{email: [The email field is required.], amount: [The amount must be
            a number.]}`.
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        status:
          description: Always the literal string `error`.
          type: string
          example: error
        message:
          description: >-
            Optional summary message — present on some endpoints, absent on
            others.
          type: string
          example: The given data was invalid.
          nullable: true
      type: object
    ErrorResponse:
      title: ErrorResponse
      description: >-
        Generic error envelope used by most controllers. Most error responses
        pair a human-readable `message` with `status: error`. Some endpoints
        additionally include `errors` (validator errors), `error` (legacy
        single-error string), `code`, or domain-specific context fields.
      required:
        - message
      properties:
        message:
          description: Human-readable error message.
          type: string
          example: Something went wrong. Please try again.
        status:
          description: >-
            Always the literal string `error` for failures. Some endpoints omit
            this field.
          type: string
          example: error
        error:
          description: Legacy single error code/string used by older endpoints.
          type: string
          example: invalid_request
          nullable: true
        code:
          description: >-
            Optional application-level error code (not all endpoints populate
            this).
          type: string
          example: DONOR_NOT_FOUND
          nullable: true
      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.