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

# Review HubSpot mapping and import readiness

> Synchronously discovers metadata if requested or missing, ensures templates, persists mapping/ownership conflicts and predicts sample company/contact outcomes without creating donor/household records or writing provider records. Completion can include errors/conflicts; inspect counters and summary. Default sample metadata size 5; preview page_size defaults to 25 and max_pages defaults to 1, with preview pages capped at 3 even though validation accepts 25. Requires the integration platform global/configured client feature gate (normally integration_platform_foundation). Requires permission: one of access_account_settings.



## OpenAPI

````yaml post /integrations/hub/connections/{connection_id}/hubspot/dry-run
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:
  /integrations/hub/connections/{connection_id}/hubspot/dry-run:
    post:
      tags:
        - Integrations
      summary: Review HubSpot mapping and import readiness
      description: >-
        Synchronously discovers metadata if requested or missing, ensures
        templates, persists mapping/ownership conflicts and predicts sample
        company/contact outcomes without creating donor/household records or
        writing provider records. Completion can include errors/conflicts;
        inspect counters and summary. Default sample metadata size 5; preview
        page_size defaults to 25 and max_pages defaults to 1, with preview pages
        capped at 3 even though validation accepts 25. Requires the integration
        platform global/configured client feature gate (normally
        integration_platform_foundation). Requires permission: one of
        access_account_settings.
      operationId: integrationHubspotDryRun
      parameters:
        - name: connection_id
          in: path
          description: Connection id in the current organization.
          required: true
          schema:
            type: integer
          example: 42
      requestBody:
        description: Validated request fields for this operation.
        required: false
        content:
          application/json:
            schema:
              properties:
                refresh_metadata:
                  description: 'Refresh metadata. Validation: nullable, boolean.'
                  type: boolean
                  example: true
                  nullable: true
                sample_size:
                  description: 'Sample size. Validation: nullable, integer, min:1, max:25.'
                  type: integer
                  maximum: 25
                  minimum: 1
                  example: 1
                  nullable: true
                page_size:
                  description: 'Page size. Validation: nullable, integer, min:1, max:100.'
                  type: integer
                  maximum: 100
                  minimum: 1
                  example: 1
                  nullable: true
                max_pages:
                  description: 'Max pages. Validation: nullable, integer, min:1, max:25.'
                  type: integer
                  maximum: 25
                  minimum: 1
                  example: 1
                  nullable: true
              type: object
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    properties:
                      sync_run_id:
                        description: Organization-owned record identifier.
                        type: integer
                        example: 42
                        nullable: false
                      sync_run:
                        $ref: '#/components/schemas/IntegrationHubSpotRun'
                    type: object
                  message:
                    description: Operation receipt.
                    type: string
                    example: Example
                    nullable: false
                type: object
        '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: >-
            Feature, organization-owned connection or selected donor form is
            unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '422':
          description: >-
            Request, selected provider, tenant form/program/property or required
            settings validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestRejection'
        '500':
          description: Synchronous provider metadata or sample review could not complete.
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    IntegrationHubSpotRun:
      description: >-
        Stored run projection. Queued receipts do not confirm eventual provider
        success; read the run/history to inspect actual results.
      properties:
        id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        connection_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        provider_key:
          type: string
          enum:
            - hubspot
        run_type:
          description: Display or configured value.
          type: string
          example: Example
          nullable: false
        trigger_source:
          description: Display or configured value.
          type: string
          example: Example
          nullable: false
        direction:
          description: Display or configured value.
          type: string
          example: Example
          nullable: false
        status:
          description: Display or configured value.
          type: string
          example: Example
          nullable: false
        object_types_json:
          type: array
          items:
            type: string
        counters_json:
          properties:
            created:
              description: Count.
              type: integer
              minimum: 0
              example: 2
            updated:
              description: Count.
              type: integer
              minimum: 0
              example: 2
            skipped:
              description: Count.
              type: integer
              minimum: 0
              example: 2
            failed:
              description: Count.
              type: integer
              minimum: 0
              example: 2
            conflicted:
              description: Count.
              type: integer
              minimum: 0
              example: 2
            retried:
              description: Count.
              type: integer
              minimum: 0
              example: 2
          type: object
          nullable: true
        summary_json:
          description: >-
            Provider run summary. Dry-run counters are predictions and can
            contain errors/conflicts even when the run completes; queued runs
            may not have summary data yet.
          properties:
            template_variant:
              description: Display or configured value.
              type: string
              example: Example
              nullable: true
            metadata_snapshot_id:
              description: Organization-owned record identifier.
              type: integer
              example: 42
              nullable: false
            metadata_snapshot_version:
              description: Count.
              type: integer
              minimum: 0
              example: 2
            context:
              $ref: '#/components/schemas/IntegrationHubSpotContext'
            context_errors:
              type: array
              items:
                properties:
                  code:
                    description: Display or configured value.
                    type: string
                    example: Example
                    nullable: false
                  message:
                    description: Display or configured value.
                    type: string
                    example: Example
                    nullable: false
                type: object
            mapping_reviews:
              type: array
              items:
                properties:
                  mapping_id:
                    description: Organization-owned record identifier.
                    type: integer
                    example: 42
                    nullable: false
                  hys_object_type:
                    description: Display or configured value.
                    type: string
                    example: Example
                    nullable: false
                  provider_object_type:
                    description: Display or configured value.
                    type: string
                    example: Example
                    nullable: false
                  status:
                    type: string
                    enum:
                      - ready
                      - warning
                      - conflict
                      - error
                  warnings:
                    type: array
                    items:
                      type: string
                  errors:
                    type: array
                    items:
                      type: string
                  conflicts:
                    type: array
                    items:
                      type: string
                type: object
            object_summaries:
              type: object
              additionalProperties:
                properties:
                  fetched:
                    description: Count.
                    type: integer
                    minimum: 0
                    example: 2
                  created:
                    description: Count.
                    type: integer
                    minimum: 0
                    example: 2
                  updated:
                    description: Count.
                    type: integer
                    minimum: 0
                    example: 2
                  skipped:
                    description: Count.
                    type: integer
                    minimum: 0
                    example: 2
                  failed:
                    description: Count.
                    type: integer
                    minimum: 0
                    example: 2
                  conflicted:
                    description: Count.
                    type: integer
                    minimum: 0
                    example: 2
                  duplicate_candidates:
                    description: Count.
                    type: integer
                    minimum: 0
                    example: 2
                  required_field_failures:
                    description: Count.
                    type: integer
                    minimum: 0
                    example: 2
                  warnings:
                    type: array
                    items:
                      type: string
                type: object
            mode:
              description: Display or configured value.
              type: string
              example: Example
              nullable: true
            processed_outbox_events:
              description: Count.
              type: integer
              minimum: 0
              example: 2
          type: object
          nullable: true
          additionalProperties: {}
        context_json:
          description: Run mode/provider/options or metadata-snapshot context.
          oneOf:
            - type: object
              additionalProperties: {}
            - type: array
              items: {}
            - type: string
              enum:
                - null
              nullable: true
        error_summary_json:
          description: Dry-run mapping errors or classified processing failure details.
          oneOf:
            - type: object
              additionalProperties: {}
            - type: array
              items: {}
            - type: string
              enum:
                - null
              nullable: true
        started_at:
          description: Timestamp.
          type: string
          format: date-time
          nullable: true
        finished_at:
          description: Timestamp.
          type: string
          format: date-time
          nullable: true
        created_at:
          description: Timestamp.
          type: string
          format: date-time
          nullable: true
        updated_at:
          description: Timestamp.
          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
    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
    IntegrationHubSpotContext:
      description: >-
        Stored connection settings can include additional provider keys. Save
        endpoints have their documented defaults when fields are omitted.
      properties:
        donor_hysform_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        company_target_mode:
          type: string
          enum:
            - household
            - organization_donor
        allow_email_match:
          type: boolean
          example: true
        company_match_by_name:
          type: boolean
          example: true
        activity_sync_enabled:
          type: boolean
          example: true
        activity_types:
          type: array
          items:
            type: string
            enum:
              - note
              - task
              - call
              - meeting
              - email
        activity_link_policy:
          type: string
          enum:
            - matched_only
            - import_unmatched
        activity_body_visibility:
          type: string
          enum:
            - team
            - private
        deal_sync_enabled:
          type: boolean
          example: true
        deal_stage_ids:
          type: array
          items:
            type: string
        product_sync_enabled:
          type: boolean
          example: true
        product_program_ids:
          type: array
          items:
            description: Organization-owned record identifier.
            type: integer
            example: 42
            nullable: false
        product_field_mapping:
          properties:
            name:
              description: Gratona recipient field key/path.
              type: string
              example: Example
              nullable: true
            description:
              description: Gratona recipient field key/path.
              type: string
              example: Example
              nullable: true
            price:
              description: Gratona recipient field key/path.
              type: string
              example: Example
              nullable: true
            sku:
              description: Gratona recipient field key/path.
              type: string
              example: Example
              nullable: true
          type: object
        product_program_field_mappings:
          description: Product field choices keyed by numeric Gratona program id.
          type: object
          additionalProperties:
            properties:
              name:
                description: Gratona recipient field key/path.
                type: string
                example: Example
                nullable: true
              description:
                description: Gratona recipient field key/path.
                type: string
                example: Example
                nullable: true
              price:
                description: Gratona recipient field key/path.
                type: string
                example: Example
                nullable: true
              sku:
                description: Gratona recipient field key/path.
                type: string
                example: Example
                nullable: true
            type: object
        deal_outbound_enabled:
          type: boolean
          example: true
        deal_outbound_pipeline_id:
          description: Display or configured value.
          type: string
          example: Example
          nullable: true
        deal_outbound_stage_id:
          description: Display or configured value.
          type: string
          example: Example
          nullable: true
      type: object
      additionalProperties: {}
    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.