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

# Connect an EmailOctopus audience account

> Validates and stores an EmailOctopus API key for direct audience delivery. Requires a non-viewer member of the authenticated organization using bearer authentication. Supply connectedAccountId to replace authorization on an existing account while preserving its destinations and delivery history; pause its destinations and let pending deliveries settle first. Repeated connections with the same key reuse the account. This operation does not send contacts, select a list, retry old deliveries or resume destinations. Validate and activate the selected destination separately. Existing destinationType and pipedreamAccountId fields remain compatibility identifiers; authentication identifies direct API-key accounts. Requests share a 120-per-60-second allowance per source IP within this route family. Credentials are never returned. Dedicated admin API credentials also authorize platform-wide management, including white-label targets; customer bearer/API-key restrictions described above remain unchanged. Existing resource validation and business-state rules still apply.



## OpenAPI

````yaml https://api.aws53.cloud/openapi-intent.json post /v1/intent/integrations/emailoctopus/connect
openapi: 3.1.0
info:
  title: Orbit API
  version: 1.0.0
  description: >-
    Orbit Audience Intent API: topic discovery, site analysis, curated ICP
    filters, saved audiences, materialization runs, stats, and CSV export.
    Discovery endpoints are public; audience management accepts either Bearer
    JWT or X-API-Key auth.
servers:
  - url: https://api.aws53.cloud
    description: Production
security: []
tags:
  - name: Topic Discovery
    description: Browse, search, and analyze available intent topics
  - name: Site Analysis
    description: Analyze a website URL to find matching intent topics
  - name: Site Topics
    description: Recent organization site-topic analyses
  - name: Audience Builder
    description: >-
      Curated filters, preview, saved audiences, runs, exports, webhooks, and
      managed destinations
paths:
  /v1/intent/integrations/emailoctopus/connect:
    post:
      tags:
        - Audience Builder
      summary: Connect an EmailOctopus audience account
      description: >-
        Validates and stores an EmailOctopus API key for direct audience
        delivery. Requires a non-viewer member of the authenticated organization
        using bearer authentication. Supply connectedAccountId to replace
        authorization on an existing account while preserving its destinations
        and delivery history; pause its destinations and let pending deliveries
        settle first. Repeated connections with the same key reuse the account.
        This operation does not send contacts, select a list, retry old
        deliveries or resume destinations. Validate and activate the selected
        destination separately. Existing destinationType and pipedreamAccountId
        fields remain compatibility identifiers; authentication identifies
        direct API-key accounts. Requests share a 120-per-60-second allowance
        per source IP within this route family. Credentials are never returned.
        Dedicated admin API credentials also authorize platform-wide management,
        including white-label targets; customer bearer/API-key restrictions
        described above remain unchanged. Existing resource validation and
        business-state rules still apply.
      operationId: connectAudienceEmailoctopus
      parameters:
        - name: X-Whitelabel-Slug
          in: header
          required: false
          description: >-
            Optional tenant context for admin-key operations without an
            organization target, such as creating an organization. Defaults to
            the master tenant. Must match an explicit target organization when
            both are supplied. Does not limit the key’s platform authority.
          schema:
            type: string
            minLength: 1
            maxLength: 100
          example: agency-test
        - name: X-Organization-Id
          in: header
          required: false
          description: >-
            Target organization for admin-key requests on organization-context
            routes, including Data API, intent audiences and dashboard routes
            without an organization path parameter. Required on those routes.
            When supplied with an organization path parameter, both must
            identify the same organization; conflicting targets return 400. Does
            not grant access to customer credentials.
          schema:
            type: string
            format: uuid
          example: 11111111-1111-4111-8111-111111111111
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                apiKey:
                  type: string
                  minLength: 10
                  maxLength: 500
                  description: >-
                    Private EmailOctopus API key; stored encrypted and never
                    returned.
                  example: synthetic-emailoctopus-key
                connectedAccountId:
                  type: string
                  format: uuid
                  description: >-
                    Existing account in this organization whose authorization
                    should be replaced.
                  example: 66666666-6666-4666-8666-666666666666
              required:
                - apiKey
              additionalProperties: false
            example:
              apiKey: synthetic-emailoctopus-key
      responses:
        '200':
          description: Connected native account
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      pipedreamAccountId:
                        type: string
                      appSlug:
                        type: string
                        enum:
                          - emailoctopus
                      appName:
                        type: string
                      accountName:
                        type:
                          - string
                          - 'null'
                      status:
                        type: string
                        enum:
                          - healthy
                          - unhealthy
                          - disconnected
                      lastSyncedAt:
                        type: string
                      authentication:
                        type: string
                        enum:
                          - native_api_key
                          - pipedream
                        description: >-
                          Authorization method. Native accounts connect directly
                          using an API key.
                        example: native_api_key
                    required:
                      - id
                      - pipedreamAccountId
                      - appSlug
                      - appName
                      - accountName
                      - status
                      - lastSyncedAt
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                      request_id:
                        type: string
                    required:
                      - timestamp
                      - request_id
                required:
                  - data
                  - meta
              example:
                data:
                  id: 66666666-6666-4666-8666-666666666666
                  pipedreamAccountId: apn_example
                  appSlug: emailoctopus
                  appName: EmailOctopus
                  accountName: Example newsletter
                  status: healthy
                  lastSyncedAt: '2026-01-15T12:00:00.000Z'
                  authentication: native_api_key
                meta:
                  timestamp: '2026-01-15T12:00:00.000Z'
                  request_id: example-request
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details: {}
                    required:
                      - code
                      - message
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                      request_id:
                        type: string
                    required:
                      - timestamp
                      - request_id
                required:
                  - error
                  - meta
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details: {}
                    required:
                      - code
                      - message
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                      request_id:
                        type: string
                    required:
                      - timestamp
                      - request_id
                required:
                  - error
                  - meta
        '403':
          description: Not allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details: {}
                    required:
                      - code
                      - message
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                      request_id:
                        type: string
                    required:
                      - timestamp
                      - request_id
                required:
                  - error
                  - meta
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details: {}
                    required:
                      - code
                      - message
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                      request_id:
                        type: string
                    required:
                      - timestamp
                      - request_id
                required:
                  - error
                  - meta
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details: {}
                    required:
                      - code
                      - message
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                      request_id:
                        type: string
                    required:
                      - timestamp
                      - request_id
                required:
                  - error
                  - meta
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details: {}
                    required:
                      - code
                      - message
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                      request_id:
                        type: string
                    required:
                      - timestamp
                      - request_id
                required:
                  - error
                  - meta
        '500':
          description: Provider or internal failure
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details: {}
                    required:
                      - code
                      - message
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                      request_id:
                        type: string
                    required:
                      - timestamp
                      - request_id
                required:
                  - error
                  - meta
        '503':
          description: Integration configuration or provider temporarily unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details: {}
                    required:
                      - code
                      - message
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                      request_id:
                        type: string
                    required:
                      - timestamp
                      - request_id
                required:
                  - error
                  - meta
      security:
        - bearerAuth: []
        - apiKeyAuth: []
        - adminApiKeyAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Dashboard access token. Send as Authorization: Bearer <token>.'
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Organization API key (sk_...). Send as X-API-Key: <key>.'
    adminApiKeyAuth:
      type: apiKey
      in: header
      name: X-Admin-API-Key
      description: >-
        Dedicated full-access management credential, issued to an active
        master-superadmin actor. Never a customer organization API key. Use one
        credential per request. Admin-header requests are limited to 600 per 60
        seconds per source IP per process, in addition to existing route limits;
        429 responses emit Retry-After and RateLimit-Limit/Remaining/Reset.
        Organization-scoped operations require X-Organization-Id where no target
        organization is in the path.

````

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