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

# Create an email import intake

> Manage schedules, transfers, destinations and import workflows.

Required scopes: `metrics:write`.


## OpenAPI

````yaml POST /api/v2/metrics/import-email-intakes
openapi: 3.1.1
info:
  title: chatobserver public API
  version: '2026-09-09'
  description: >-
    Track AI visibility, manage prompts, inspect collected answers and
    citations, and integrate workspace data with your own tools. Visibility
    endpoints use workspace API keys. Data endpoints use scoped service-account
    keys; spreadsheet client endpoints use authorised client sessions. See the
    authentication guide for each credential type.
  contact:
    name: chatobserver support
    url: https://chatobserver.com/contact
    email: support@chatobserver.com
servers:
  - url: https://app.chatobserver.com
    description: Production API
security:
  - WorkspaceKey: []
  - BearerKey: []
tags:
  - name: Workspace
    description: Validate access and list the workspace project and available platforms.
  - name: Prompts
    description: Create, schedule, organise, activate and retrieve tracked prompts.
  - name: Answers
    description: Retrieve collected AI answers, their analysis and visibility trends.
  - name: Brands
    description: Manage brands and compare their visibility in AI answers.
  - name: Sources and citations
    description: Analyse cited domains, pages and ownership across answers.
  - name: Visitor analytics
    description: Read website visitor and crawler analytics for the workspace.
  - name: Content opportunities
    description: Retrieve content-gap findings and recommendations for tracked prompts.
  - name: Usage
    description: Read workspace consumption and allowance summaries.
  - name: Data connections
    description: Discover authorised connections, source accounts and connector catalogues.
  - name: Data queries
    description: >-
      Create versioned queries, publish definitions and inspect integration
      contracts.
  - name: Data operations
    description: >-
      Execute, validate, cancel and inspect operations and page through result
      rows.
  - name: Data delivery
    description: Manage schedules, transfers, destinations and import workflows.
  - name: Data definitions
    description: Manage reusable definitions and their immutable versions.
  - name: Data webhooks
    description: >-
      Configure event delivery, inspect deliveries, replay events and rotate
      secrets.
  - name: Client authorisation
    description: Authorise spreadsheet clients using a user-approved challenge exchange.
  - name: Spreadsheet clients
    description: >-
      Access document-bound client sessions, queries, schedules, bindings and
      write claims.
  - name: AI visibility audits
    description: Create website visibility audits and retrieve their report links.
  - name: Version 1
    description: Integrate with the version 1 visibility and analytics endpoints.
paths:
  /api/v2/metrics/import-email-intakes:
    post:
      tags:
        - Data delivery
      summary: Create an email import intake
      description: >-
        Manage schedules, transfers, destinations and import workflows. Required
        scopes: `metrics:write`.
      operationId: postV2MetricsImportEmailIntakes
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 16
            maxLength: 160
            pattern: ^[A-Za-z0-9:_-]+$
          description: >-
            Unique key for one logical command. Reuse it only when retrying the
            same request and payload.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postV2MetricsImportEmailIntakesRequest'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/postV2MetricsImportEmailIntakesResponse200
        '201':
          description: Created successfully.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/postV2MetricsImportEmailIntakesResponse201
        default:
          description: >-
            Request failed. Inspect the error code and request identifier; retry
            only when the failure is retryable.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/DataError'
                  - $ref: '#/components/schemas/ApiError'
components:
  schemas:
    postV2MetricsImportEmailIntakesRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 150
        allowedSenderDomains:
          type: array
          items:
            type: string
            minLength: 3
            maxLength: 253
          maxItems: 100
        allowedSenderHashes:
          type: array
          items:
            type: string
            pattern: ^[a-f0-9]{64}$
          maxItems: 500
        attachmentFormats:
          type: array
          items:
            enum:
              - csv
              - parquet
              - tsv
              - xlsx
              - jsonl
            type: string
          minItems: 1
          maxItems: 5
        maximumAttachmentBytes:
          type: integer
          exclusiveMinimum: 0
          maximum: 10737418240
        status:
          enum:
            - active
            - paused
          default: active
          type: string
        description:
          anyOf:
            - type: 'null'
            - type: string
              maxLength: 4000
          default: null
        publish:
          anyOf:
            - type: boolean
              const: false
            - type: boolean
              const: true
          default: true
        subjectPrefix:
          anyOf:
            - type: 'null'
            - type: string
              minLength: 1
              maxLength: 160
          default: null
      required:
        - name
        - allowedSenderDomains
        - allowedSenderHashes
        - attachmentFormats
        - maximumAttachmentBytes
      additionalProperties: false
    postV2MetricsImportEmailIntakesResponse200:
      type: object
      properties:
        data:
          type: object
          properties:
            actorId:
              type: string
            intakeId:
              type: string
            versionId:
              type: string
            addressLocalPart:
              type: string
            status:
              enum:
                - active
                - paused
              type: string
            published:
              anyOf:
                - type: boolean
                  const: false
                - type: boolean
                  const: true
          required:
            - actorId
            - intakeId
            - versionId
            - addressLocalPart
            - status
            - published
        replayed:
          anyOf:
            - type: boolean
              const: false
            - type: boolean
              const: true
      required:
        - data
        - replayed
    postV2MetricsImportEmailIntakesResponse201:
      type: object
      properties:
        data:
          type: object
          properties:
            actorId:
              type: string
            intakeId:
              type: string
            versionId:
              type: string
            addressLocalPart:
              type: string
            status:
              enum:
                - active
                - paused
              type: string
            published:
              anyOf:
                - type: boolean
                  const: false
                - type: boolean
                  const: true
          required:
            - actorId
            - intakeId
            - versionId
            - addressLocalPart
            - status
            - published
        replayed:
          anyOf:
            - type: boolean
              const: false
            - type: boolean
              const: true
      required:
        - data
        - replayed
    DataError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              enum:
                - internal
                - validation_failed
                - authentication_required
                - forbidden
                - not_found
                - conflict
                - precondition_failed
                - idempotency_conflict
                - capability_unavailable
                - connection_unavailable
                - reauthentication_required
                - provider_rate_limited
                - workspace_limit_exceeded
                - result_expired
                - operation_failed
                - temporarily_unavailable
              type: string
            fieldPath:
              type: array
              items:
                anyOf:
                  - type: string
                  - type: number
            parameters:
              type: object
              properties: {}
              additionalProperties:
                anyOf:
                  - type: 'null'
                  - type: string
                  - type: number
                  - type: boolean
                    const: false
                  - type: boolean
                    const: true
            repairActions:
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 96
              maxItems: 10
            requestId:
              type: string
              minLength: 1
              maxLength: 160
            retryable:
              anyOf:
                - type: boolean
                  const: false
                - type: boolean
                  const: true
            retryAfterSeconds:
              anyOf:
                - type: 'null'
                - type: integer
                  exclusiveMinimum: 0
          required:
            - code
            - fieldPath
            - parameters
            - repairActions
            - requestId
            - retryable
            - retryAfterSeconds
          additionalProperties: false
      required:
        - error
      additionalProperties: false
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          required:
            - code
            - message
        requestId:
          type: string
      required:
        - error
        - requestId
  securitySchemes:
    WorkspaceKey:
      type: apiKey
      in: header
      name: x-chatobserver-key
      description: >-
        A workspace API key. Data endpoints require a service-account key with
        the specified scopes.
    BearerKey:
      type: http
      scheme: bearer
      description: The workspace or service-account API key as a bearer token.

````