> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sendrealm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview import

Requires a scoped personal key, explicit project selection, and current role authorization. See [Agent imports](/tutorials/agent-imports) for validation, consent, preparation, and recovery.


## OpenAPI

````yaml api-reference/openapi.json POST /imports/{import_id}/preview
openapi: 3.0.1
info:
  title: Sendrealm API
  description: >-
    API for email, push, audience resources, domains, campaign drafts,
    templates, events, topics, and automations
  license:
    name: MIT
  version: 0.3.0
servers:
  - url: https://api.sendrealm.com
security:
  - bearerAuth: []
paths:
  /imports/{import_id}/preview:
    post:
      tags:
        - Agent imports
      summary: Preview import
      operationId: imports_preview
      parameters:
        - name: X-Sendrealm-Project-Id
          in: header
          required: true
          schema:
            type: string
            format: uuid
        - name: import_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties: {}
              additionalProperties: false
              x-sendrealm-mcp-contract: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  data:
                    $ref: '#/components/schemas/McpImportPreview'
                additionalProperties: false
                x-sendrealm-mcp-contract: true
                required:
                  - status
                  - data
components:
  schemas:
    McpImportPreview:
      type: object
      properties:
        import_id:
          type: string
          format: uuid
        prepared_action_id:
          type: string
          format: uuid
        operation:
          type: string
          enum:
            - imports.commit
        expires_at:
          type: string
          format: date-time
        counts:
          type: array
          items:
            type: object
            properties:
              status:
                type: string
              rows:
                type: integer
                minimum: 0
            required:
              - status
              - rows
            additionalProperties: false
            x-sendrealm-mcp-contract: true
        sample:
          type: array
          maxItems: 5
          items:
            type: object
            properties:
              row_number:
                type: integer
              status:
                type: string
              error_code:
                type: string
                nullable: true
              result:
                $ref: '#/components/schemas/McpImportRowPlan'
                nullable: true
            required:
              - row_number
              - status
              - error_code
              - result
            additionalProperties: false
            x-sendrealm-mcp-contract: true
        effects:
          type: object
          properties:
            import_id:
              type: string
              format: uuid
            valid_rows:
              type: integer
              minimum: 0
            invalid_rows:
              type: integer
              minimum: 0
            automation_effects:
              type: string
              enum:
                - suppress
                - trigger
            changes:
              $ref: '#/components/schemas/McpImportChanges'
          required:
            - import_id
            - valid_rows
            - invalid_rows
            - automation_effects
            - changes
          additionalProperties: false
          x-sendrealm-mcp-contract: true
        changes:
          $ref: '#/components/schemas/McpImportChanges'
      required:
        - import_id
        - prepared_action_id
        - operation
        - expires_at
        - counts
        - sample
        - effects
        - changes
      additionalProperties: false
      x-sendrealm-mcp-contract: true
    McpImportRowPlan:
      type: object
      properties:
        action:
          type: string
          enum:
            - create
            - update
            - skip
        identity:
          type: string
        resource_id:
          type: string
          format: uuid
        version:
          type: string
        mapped:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/McpJsonValue'
          description: Proposed source data after explicit mapping.
        changes:
          type: array
          items:
            type: string
            enum:
              - contacts_created
              - contacts_updated
              - properties_created
              - audiences_created
              - memberships_created
              - memberships_updated
              - subscriptions_created
              - subscriptions_updated
          description: >-
            Actual proposed mutations. Empty means a no-op; no events are
            emitted.
      required:
        - action
        - identity
        - mapped
      additionalProperties: false
      x-sendrealm-mcp-contract: true
    McpImportChanges:
      type: object
      properties:
        contacts_created:
          type: integer
          minimum: 0
        contacts_updated:
          type: integer
          minimum: 0
        properties_created:
          type: integer
          minimum: 0
        audiences_created:
          type: integer
          minimum: 0
        memberships_created:
          type: integer
          minimum: 0
        memberships_updated:
          type: integer
          minimum: 0
        subscriptions_created:
          type: integer
          minimum: 0
        subscriptions_updated:
          type: integer
          minimum: 0
      required:
        - contacts_created
        - contacts_updated
        - properties_created
        - audiences_created
        - memberships_created
        - memberships_updated
        - subscriptions_created
        - subscriptions_updated
      additionalProperties: false
      x-sendrealm-mcp-contract: true
    McpJsonValue:
      oneOf:
        - type: string
          nullable: true
        - type: number
        - type: boolean
        - type: array
          items:
            $ref: '#/components/schemas/McpJsonValue'
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/McpJsonValue'
      description: >-
        JSON application data. Do not include credentials or unnecessary
        personal data.
      x-sendrealm-mcp-contract: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Integration key for backend workloads, or a scoped personal key
        (sr_user_) for account discovery and supported project operations. MCP
        accepts only personal keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.