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

# Edit Email With Prompt

> Prompt Migma to edit one generated email. The same emailId remains valid; the response returns updated HTML and screenshot URLs. Requires API key with email:write permission.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/emails/{emailId}/edit
openapi: 3.1.0
info:
  title: Migma.ai API (v1)
  description: >-
    API for managing brands, contacts, email generation, sending, and
    integrations.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.migma.ai
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: Projects/Brands
    description: Manage projects (brands) and import from websites
  - name: Contacts
    description: Manage your contacts, segments, tags, and topics
  - name: Segments
    description: Create and manage dynamic contact segments
  - name: Tags
    description: Organize contacts with tags
  - name: Topics
    description: Manage subscription topics and preferences
  - name: Emails
    description: Generate, send, and export emails
  - name: Email Validation
    description: Validate email content for compatibility and deliverability
  - name: Email Previews
    description: Preview emails across devices and email clients
  - name: Domains
    description: Manage sending domains and verification
  - name: Webhooks
    description: Manage webhook endpoints for real-time event notifications
  - name: Events
    description: Record customer events and conversions
  - name: Integrations
    description: Third-party platform integrations
  - name: Campaigns
    description: Create, schedule, send, and manage email campaigns
  - name: Project Editing
    description: Edit project assets, logos, images, and knowledge base entries
paths:
  /v1/emails/{emailId}/edit:
    post:
      tags:
        - Emails
      summary: Edit Email With Prompt
      description: >-
        Prompt Migma to edit one generated email. The same emailId remains
        valid; the response returns updated HTML and screenshot URLs. Requires
        API key with email:write permission.
      operationId: EditEmailWithPrompt
      parameters:
        - name: emailId
          in: path
          description: Email ID returned in generation status result.emails[].emailId.
          required: true
          schema:
            type: string
            pattern: ^[0-9a-fA-F]{24}$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditEmailRequest'
      responses:
        '200':
          description: Email edited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseEmail'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      x-codeSamples:
        - lang: javascript
          label: Node.js SDK
          source: |-
            import Migma from 'migma';

            const migma = new Migma('YOUR_API_KEY');

            const { data } = await migma.emails.edit('EMAIL_ID', {
              prompt: 'Make this welcome email shorter and more transactional'
            });

            console.log(data.html);
components:
  schemas:
    EditEmailRequest:
      type: object
      properties:
        prompt:
          type: string
          description: >-
            Natural-language edit request, e.g. "Make this shorter and more
            transactional".
        label:
          type: string
          description: Optional version label.
      required:
        - prompt
    ApiResponseEmail:
      allOf:
        - $ref: '#/components/schemas/ApiResponse'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/Email'
    ApiResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          nullable: true
        error:
          type: string
          nullable: true
      required:
        - success
    Email:
      type: object
      properties:
        id:
          type: string
        emailId:
          type: string
        conversationId:
          type: string
        messageId:
          type:
            - string
            - 'null'
        slotIdx:
          type: integer
        slotUuid:
          type:
            - string
            - 'null'
        status:
          type: string
        subject:
          type: string
        preheader:
          type: string
        html:
          type: string
          description: Production-ready email HTML.
        screenshotUrl:
          type:
            - string
            - 'null'
          format: uri
        thumbnailUrl:
          type:
            - string
            - 'null'
          format: uri
        warnings:
          type: array
          items:
            type: string
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - emailId
        - conversationId
        - messageId
        - slotIdx
        - slotUuid
        - status
        - subject
        - preheader
        - html
        - warnings
        - thumbnailUrl
        - updatedAt
    ApiError:
      type: object
      properties:
        success:
          type: boolean
          default: false
        error:
          type: string
        code:
          type: string
          description: >-
            Machine-readable error code (e.g., IDEMPOTENCY_CONFLICT,
            DOMAIN_CLAIMABLE).
        data:
          type: object
          description: >-
            Additional structured context for the error, such as the affected
            domain.
          additionalProperties: true
      required:
        - success
        - error
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: Forbidden - Missing required permissions or access denied
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Use 'Authorization: Bearer YOUR_API_KEY' where
        YOUR_API_KEY is obtained from the Migma dashboard under Settings →
        Developers → API Keys.

````