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

# Log a donor manual interaction

> Requires manual_interactions and current interaction/record authority. Body visibility can restrict read/edit/delete even when timeline metadata is visible. Shared visibility requires a valid organization shared_group_id. Event invitation participants and related tasks require access and current version boundaries. type, occurred_at and a nonblank subject are required. A body idempotency_key or fallback Idempotency-Key header reuses the interaction without replaying acknowledgement mutations. Donation acknowledgement needs donations/full-organization permission; selected gifts must qualify and occur no later than the interaction. Attachments use multipart form data.



## OpenAPI

````yaml post /donors/{donor_id}/interactions/manual
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:
  /donors/{donor_id}/interactions/manual:
    post:
      tags:
        - Email Calendar
      summary: Log a donor manual interaction
      description: >-
        Requires manual_interactions and current interaction/record authority.
        Body visibility can restrict read/edit/delete even when timeline
        metadata is visible. Shared visibility requires a valid organization
        shared_group_id. Event invitation participants and related tasks require
        access and current version boundaries. type, occurred_at and a nonblank
        subject are required. A body idempotency_key or fallback Idempotency-Key
        header reuses the interaction without replaying acknowledgement
        mutations. Donation acknowledgement needs donations/full-organization
        permission; selected gifts must qualify and occur no later than the
        interaction. Attachments use multipart form data.
      operationId: docManualInteractionStorePOST
      parameters:
        - name: donor_id
          in: path
          description: Donor id.
          required: true
          schema:
            type: integer
          example: 123
      requestBody:
        description: >-
          Request fields accepted by this operation. Omitted optional properties
          retain the behavior described above.
        required: true
        content:
          multipart/form-data:
            schema:
              required:
                - type
                - occurred_at
                - subject
              properties:
                type:
                  type: string
                  enum:
                    - call
                    - meeting
                    - visit
                    - note
                    - sms
                    - email
                    - letter
                    - voicemail
                    - other
                subject:
                  description: 'Validation: `nullable|string|max:255`.'
                  type: string
                  maxLength: 255
                  nullable: true
                body_plain:
                  description: 'Validation: `nullable|string|max:20000`.'
                  type: string
                  maxLength: 20000
                  nullable: true
                body:
                  description: 'Validation: `nullable|string|max:20000`.'
                  type: string
                  maxLength: 20000
                  nullable: true
                occurred_at:
                  description: 'Validation: `required|date`.'
                  type: string
                  format: date-time
                body_visibility:
                  description: 'Validation: `nullable|in:private,metadata,shared,team`.'
                  type: string
                  enum:
                    - private
                    - metadata
                    - shared
                    - team
                    - null
                  nullable: true
                direction:
                  type: string
                  enum:
                    - inbound
                    - outbound
                    - internal
                    - none
                    - null
                  nullable: true
                outcome:
                  type: string
                  enum:
                    - completed
                    - left_voicemail
                    - no_answer
                    - scheduled_follow_up
                    - needs_follow_up
                    - resolved
                    - other
                    - null
                  nullable: true
                duration_minutes:
                  description: 'Validation: `nullable|integer|min:1|max:1440`.'
                  type: integer
                  maximum: 1440
                  minimum: 1
                  nullable: true
                follow_up_at:
                  description: 'Validation: `nullable|date`.'
                  type: string
                  format: date-time
                  nullable: true
                counts_as_touch:
                  description: 'Validation: `nullable|boolean`.'
                  type: boolean
                  nullable: true
                external_reference:
                  description: 'Validation: `nullable|string|max:255`.'
                  type: string
                  maxLength: 255
                  nullable: true
                shared_group_id:
                  description: 'Validation: `nullable|integer|min:1`.'
                  type: integer
                  minimum: 1
                  nullable: true
                idempotency_key:
                  description: 'Validation: `nullable|string|max:191`.'
                  type: string
                  maxLength: 191
                  nullable: true
                event_id:
                  description: 'Validation: `nullable|integer`.'
                  type: integer
                  nullable: true
                participant_donor_ids:
                  type: array
                  items:
                    type: integer
                  maxItems: 50
                  uniqueItems: true
                  nullable: true
                participants:
                  type: array
                  items:
                    required:
                      - donor_id
                    properties:
                      donor_id:
                        description: 'Validation: `required|integer`.'
                        type: integer
                      role:
                        description: 'Validation: `nullable|string|max:40`.'
                        type: string
                        maxLength: 40
                        nullable: true
                      event_invitee_id:
                        description: 'Validation: `nullable|integer|min:1`.'
                        type: integer
                        minimum: 1
                        nullable: true
                      invitation_action:
                        type: string
                        enum:
                          - attempt
                          - sent
                          - response_received
                          - null
                        nullable: true
                      invitation_method:
                        type: string
                        enum:
                          - phone_call
                          - text_message
                          - email
                          - handwritten_note
                          - printed_mail
                          - in_person
                          - voicemail
                          - other
                          - null
                        nullable: true
                      invitation_response_outcome:
                        type: string
                        enum:
                          - accepted
                          - maybe
                          - declined
                          - needs_follow_up
                          - null
                        nullable: true
                      expected_invitee_version:
                        description: 'Validation: `nullable|integer|min:1`.'
                        type: integer
                        minimum: 1
                        nullable: true
                    type: object
                  maxItems: 50
                  nullable: true
                related_tasks:
                  type: array
                  items:
                    required:
                      - record_type
                      - record_id
                      - expected_version
                    properties:
                      record_type:
                        description: 'Validation: `required|in:task`.'
                        type: string
                        enum:
                          - task
                      record_id:
                        description: 'Validation: `required|integer|min:1`.'
                        type: integer
                        minimum: 1
                      expected_version:
                        description: 'Validation: `required|integer|min:1`.'
                        type: integer
                        minimum: 1
                      complete:
                        description: 'Validation: `nullable|boolean`.'
                        type: boolean
                        nullable: true
                    type: object
                  maxItems: 25
                  nullable: true
                ai_summary:
                  description: Stored only when manual_interactions_ai_summary is enabled.
                  type: object
                  nullable: true
                  additionalProperties: true
                acknowledge_donation_ids:
                  type: array
                  items:
                    type: integer
                  maxItems: 100
                  uniqueItems: true
                  nullable: true
                attachments:
                  description: >-
                    Up to ten total files,10MiB each. Extensions:
                    pdf,doc,docx,xls,xlsx,txt,csv,jpg,jpeg,gif,png,webp. MIME
                    must also match the supported file policy.
                  type: array
                  items:
                    type: string
                    format: binary
                  maxItems: 10
              type: object
      responses:
        '201':
          description: Log a donor manual interaction response.
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/CalendarManualInteractionDoc'
                  acknowledgement:
                    properties:
                      updated_count:
                        type: integer
                      items:
                        type: array
                        items:
                          description: Acknowledgement result for each selected donation.
                          type: object
                          additionalProperties: true
                    type: object
                    nullable: true
                type: object
        '401':
          description: Missing or invalid bearer token or API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: >-
            The caller lacks the required permission, resource access or feature
            availability.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            The organization-owned resource or parent was not found or is not
            available for this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '409':
          description: >-
            The request conflicts with the current resource state or service
            configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Request validation or a domain constraint failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestRejection'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    CalendarManualInteractionDoc:
      properties:
        id:
          type: integer
        kind:
          type: string
        type:
          type: string
        client_id:
          type: integer
        donor_id:
          type: integer
          nullable: true
        owner_user_id:
          type: integer
          nullable: true
        owner_name:
          type: string
          nullable: true
        source:
          type: string
        subject:
          type: string
          nullable: true
        body_visibility:
          type: string
        shared_group_id:
          type: integer
          nullable: true
        occurred_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
        direction:
          type: string
        outcome:
          type: string
          nullable: true
        duration_minutes:
          type: integer
          nullable: true
        follow_up_at:
          type: string
          format: date-time
          nullable: true
        counts_as_touch:
          type: boolean
        external_reference:
          type: string
          nullable: true
        snippet:
          type: string
          nullable: true
        attachment_count:
          type: integer
        can_view_body:
          type: boolean
        body_plain:
          type: string
          nullable: true
        ai_summary:
          type: object
          nullable: true
          additionalProperties: true
        import:
          type: object
          nullable: true
          additionalProperties: true
        attachments:
          type: array
          items:
            properties:
              id:
                type: integer
              filename:
                type: string
              original_filename:
                type: string
              mime_type:
                type: string
              file_size:
                type: integer
              file_path:
                type: string
              download_url:
                type: string
                nullable: true
              storage_url:
                type: string
              created_at:
                type: string
                format: date-time
                nullable: true
            type: object
        related_event:
          properties:
            id:
              type: integer
            name:
              type: string
            status:
              type: string
            starts_at:
              type: string
              format: date-time
              nullable: true
          type: object
          nullable: true
        related_tasks:
          type: array
          items:
            properties:
              id:
                type: integer
              title:
                type: string
              status:
                type: string
              due_date:
                type: string
                format: date
                nullable: true
              version:
                type: integer
            type: object
        version:
          type: string
          format: date-time
          nullable: true
      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
    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
    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
    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
  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.