# Enable email forwarding

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v2/domains/email-forwarding:
    post:
      summary: Enable email forwarding
      deprecated: false
      description: >
        This api enables email forwarding for one or more registered domains.
        Email forwarding redirects all incoming emails sent to the target
        domain's mailboxes to a designated recipient address.
      tags:
        - domains
      parameters:
        - name: x-auth-zapmail
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: x-workspace-key
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
        - name: ' x-service-provider'
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                domainIds:
                  type: array
                  items:
                    type: string
                  description: Array of domain ids to add email forwarding to.
                email:
                  type: string
                  description: Destination email address to forward incoming emails to.
                contains:
                  type: string
                  description: Search filter to target domains with the given substring
                status:
                  type: array
                  items:
                    type: string
                    enum:
                      - ACTIVE
                      - INACTIVE
                      - PENDING
                      - IN_PROGRESS
                      - EXPIRED
                    x-apidog-enum:
                      - value: ACTIVE
                        name: ACTIVE
                        description: ''
                      - value: INACTIVE
                        name: INACTIVE
                        description: ''
                      - value: PENDING
                        name: PENDING
                        description: ''
                      - value: IN_PROGRESS
                        name: IN_PROGRESS
                        description: ''
                      - value: EXPIRED
                        name: EXPIRED
                        description: ''
                  description: Array of status of target domains.
                tagIds:
                  type: array
                  items:
                    type: string
                  description: Array of tag ids of the target domains.
              required:
                - domainIds
                - email
                - contains
                - status
                - tagIds
              x-apidog-orders:
                - domainIds
                - email
                - contains
                - status
                - tagIds
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: 'null'
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 200
                message: Email forwarding will update soon
                data: null
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: domains
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797058/apis/api-13521023-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.zapmail.ai/api
    description: Prod Env
security: []

```