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

# Edit an email

> Changes the subject or body of a written email before approval. Send the revision you read.

Permission: `messages:write`

[Read the recovery rules](https://docs.emailx.ai/en/api-reference/idempotency.md) before retrying a write. Keep the same key and body for the same logical operation.


## OpenAPI

````yaml openapi/emailx.en.json PATCH /workspaces/{workspace_id}/campaigns/email/{campaign_id}/messages/{task_id}
openapi: 3.0.3
info:
  title: Emailx API
  version: 1.0.0-beta
  description: >-
    Customer and agency integrations for Emailx. Beta access is operator-issued.
    The v1 beta supports bounded People CSV/XLSX imports, saved email-template
    settings, selected email generation with explicit AI-credit confirmation,
    exact-message approval, reviewed email activation for native scheduled
    sending, and explicitly confirmed inbox replies bound to saved context when
    host capabilities permit. Inbox context is bounded and may be incomplete or
    stale; no provider refresh occurs. Manual LinkedIn imports, reviewed
    activation and reviewed resume of paused campaigns are separate gated
    workflows. Reply drafts, knowledge, team, infrastructure quotes with hosted
    checkout and agency administration are covered by separate scopes. Signed
    webhooks report durable operation outcomes. It does not support immediate
    batches or direct card charges.
servers:
  - url: https://app.emailx.ai/api/v1
    description: Emailx application · access must be enabled
security: []
tags:
  - name: Getting started
  - name: Workspaces
  - name: Contacts
  - name: Templates
  - name: Campaigns
  - name: Inbox
  - name: Senders
  - name: Team
  - name: Analytics
  - name: Imports
  - name: Operations
  - name: Knowledge
  - name: Infrastructure
  - name: Agency
paths:
  /workspaces/{workspace_id}/campaigns/email/{campaign_id}/messages/{task_id}:
    patch:
      tags:
        - Write and approve emails
      summary: Edit an email
      description: >-
        Changes the subject or body of a written email before approval. Send the
        revision you read.


        Permission: `messages:write`
      operationId: edit_api_email_message
      parameters:
        - name: workspace_id
          in: path
          required: true
          schema:
            type: integer
            minimum: 1
          description: Emailx workspace (Clients) ID, not the agency workspace link ID.
        - name: campaign_id
          in: path
          required: true
          schema:
            type: integer
            minimum: 1
          description: Resource identifier.
        - name: task_id
          in: path
          required: true
          schema:
            type: integer
            minimum: 1
          description: Resource identifier.
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[A-Za-z0-9_.:/-]+$
          description: Unique per logical mutation. Same path and body replay for 24 hours.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditEmailMessage'
            example:
              preview_id: 301
              expected_revision: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
              subject: A reviewed subject
      responses:
        '200':
          description: Success
          headers:
            X-Request-Id:
              schema:
                type: string
            Emailx-Api-Version:
              schema:
                type: string
            X-RateLimit-Limit:
              schema:
                type: string
            X-RateLimit-Remaining:
              schema:
                type: string
            X-RateLimit-Reset:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/EmailMessage'
                required:
                  - data
              example:
                data:
                  workspace_id: 123
                  campaign_id: 456
                  task_id: 101
                  workflow_email_id: 1001
                  contact_id: 789
                  preview_id: 301
                  recipient_email: alex@example.com
                  sender_email: sender@example.com
                  sender_id: 903
                  status: preview_ready
                  subject: A reviewed subject
                  body_text: Hello Alex
                  body_html: <p>Hello Alex</p>
                  preheader: A brief introduction
                  revision: >-
                    aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
                  delivery_verified: false
        '400':
          description: Request error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Invalid, expired or revoked API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Insufficient scope or write permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource missing or inaccessible
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict, concurrent request or uncertain original result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              schema:
                type: string
              description: Seconds to wait when present.
        '413':
          description: Request error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '415':
          description: Request error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited; respect Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              schema:
                type: string
              description: Seconds to wait when present.
        '500':
          description: Request error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: API disabled, request storage unavailable or feature not enabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              schema:
                type: string
              description: Seconds to wait when present.
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: cURL
          source: >-
            curl -X PATCH
            "https://app.emailx.ai/api/v1/workspaces/123/campaigns/email/456/messages/101"
            \
              -H "Authorization: Bearer $EMAILX_API_KEY" \
              -H "Content-Type: application/json" \
              -H "Idempotency-Key: example-operation-001" \
              --data '{"preview_id":301,"expected_revision":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","subject":"A reviewed subject"}'
        - lang: Python
          source: |-
            import os, requests

            response = requests.patch(
                "https://app.emailx.ai/api/v1/workspaces/123/campaigns/email/456/messages/101",
                headers={"Authorization": "Bearer " + os.environ["EMAILX_API_KEY"], "Idempotency-Key": "example-operation-001"},
                json={'preview_id': 301, 'expected_revision': 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'subject': 'A reviewed subject'},
                timeout=30,
            )
            response.raise_for_status()
            print(response.json())
        - lang: JavaScript
          source: >-
            const response = await
            fetch("https://app.emailx.ai/api/v1/workspaces/123/campaigns/email/456/messages/101",
            {
              method: "PATCH",
              headers: { Authorization: `Bearer ${process.env.EMAILX_API_KEY}`, "Content-Type": "application/json", "Idempotency-Key": "example-operation-001" },
              body: JSON.stringify({"preview_id": 301, "expected_revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "subject": "A reviewed subject"}),
              signal: AbortSignal.timeout(30000),
            });

            if (!response.ok) throw new Error(`Emailx: ${response.status}`);

            console.log(await response.json());
components:
  schemas:
    EditEmailMessage:
      type: object
      properties:
        preview_id:
          type: integer
          minimum: 1
        expected_revision:
          type: string
          pattern: ^[a-f0-9]{64}$
        subject:
          type: string
          maxLength: 500
        body_html:
          type: string
          maxLength: 5000
        preheader:
          type: string
          maxLength: 5000
      required:
        - preview_id
        - expected_revision
      minProperties: 3
      additionalProperties: false
      description: >-
        Edits only the selected current preview. Read the message again after
        editing or a stale-revision conflict.
    EmailMessage:
      type: object
      properties:
        workspace_id:
          type: integer
          minimum: 1
        campaign_id:
          type: integer
          minimum: 1
        task_id:
          type: integer
          minimum: 1
        workflow_email_id:
          type: integer
          minimum: 1
        contact_id:
          type: integer
          minimum: 1
        preview_id:
          type: integer
          minimum: 1
        recipient_email:
          type: string
          nullable: true
        sender_email:
          type: string
          nullable: true
        sender_id:
          type: integer
          minimum: 1
          nullable: true
        status:
          type: string
        subject:
          type: string
        body_text:
          type: string
        body_html:
          type: string
        preheader:
          type: string
        revision:
          type: string
          pattern: ^[a-f0-9]{64}$
        delivery_verified:
          type: boolean
          enum:
            - false
      required:
        - workspace_id
        - campaign_id
        - task_id
        - workflow_email_id
        - contact_id
        - preview_id
        - status
        - subject
        - body_text
        - body_html
        - preheader
        - revision
        - delivery_verified
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - message
            - request_id
      required:
        - error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        ex_test_ or ex_live_ key issued by an Emailx operator. Never use
        provider keys or session cookies.

````

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