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

# Patch domains



## OpenAPI

````yaml /openapi.json patch /domains/{id}
openapi: 3.1.1
info:
  title: Anima API
  version: 0.1.0
  description: >-
    The Anima API provides programmatic access to unified infrastructure for AI
    agents: create and manage agents; send and receive email; place phone calls
    and send/receive SMS and voice; store and retrieve vault credentials; manage
    agent identity; and configure webhooks for real-time events. Authenticate
    using a Bearer token or an API key passed via the X-API-Key header.
  contact:
    name: Anima Labs
    url: https://useanima.sh
    email: support@useanima.sh
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.useanima.sh/v1
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: Agents
    description: Create and manage AI agents with email and phone capabilities
  - name: Inboxes
    description: Manage email inboxes and their configurations
  - name: Messages
    description: Send, receive, and search email messages
  - name: Webhooks
    description: Register and manage webhook subscriptions for real-time events
  - name: Organizations
    description: Manage organizations and team settings
  - name: Domains
    description: Configure and verify custom email domains
  - name: Phone
    description: Manage phone numbers and SMS/voice capabilities
  - name: Invoices
    description: Track invoices, match receipts, and reconcile payments
  - name: Billing
    description: View usage, tiers, and billing information
  - name: Security
    description: Configure security policies and access controls
  - name: Vault
    description: Store and retrieve encrypted secrets
  - name: API Keys
    description: Create and manage API keys for programmatic access
paths:
  /domains/{id}:
    patch:
      operationId: domain.update
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
            description: Unique domain identifier
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                feedbackEnabled:
                  type: boolean
                  description: >-
                    Whether to enable bounce and complaint feedback processing
                    for this domain
              required: []
              description: Domain update parameters
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
                    description: Unique identifier of the domain
                  domain:
                    type: string
                    description: Fully qualified domain name
                  status:
                    enum:
                      - NOT_STARTED
                      - PENDING
                      - VERIFYING
                      - VERIFIED
                      - INVALID
                      - FAILED
                    type: string
                    description: Current verification status
                  verified:
                    type: boolean
                    description: Whether the domain has been fully verified
                  verificationCooldownUntil:
                    anyOf:
                      - type: string
                        format: date-time
                      - type: 'null'
                    description: >-
                      Earliest time a re-verification can be attempted, or null
                      if no cooldown
                  verificationToken:
                    type: string
                    description: Token value to place in DNS records for verification
                  verificationMethod:
                    enum:
                      - DNS_TXT
                      - DNS_CNAME
                    type: string
                    description: DNS record method used for domain verification
                  dkimSelector:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: >-
                      DKIM selector used for email signing, or null if not
                      configured
                  dkimPublicKey:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: >-
                      DKIM public key for DNS publication, or null if not
                      configured
                  spfConfigured:
                    type: boolean
                    description: Whether SPF DNS records are correctly configured
                  dmarcConfigured:
                    type: boolean
                    description: Whether DMARC DNS records are correctly configured
                  mxConfigured:
                    type: boolean
                    description: Whether MX DNS records are correctly configured
                  feedbackEnabled:
                    type: boolean
                    description: >-
                      Whether bounce and complaint feedback processing is
                      enabled
                  records:
                    anyOf:
                      - type: array
                        items:
                          type: object
                          properties:
                            type:
                              enum:
                                - TXT
                                - CNAME
                                - MX
                              type: string
                              description: DNS record type
                            name:
                              type: string
                              description: DNS record hostname
                            value:
                              type: string
                              description: Expected DNS record value
                            priority:
                              type: integer
                              description: >-
                                MX record priority (only applicable for MX
                                records)
                            status:
                              enum:
                                - MISSING
                                - INVALID
                                - VALID
                              type: string
                              description: Current validation status of this DNS record
                          required:
                            - type
                            - name
                            - value
                            - status
                          description: >-
                            DNS record required for domain verification and
                            email deliverability
                      - type: 'null'
                    description: >-
                      Required DNS records for this domain, or null if not yet
                      generated
                  createdAt:
                    type: string
                    format: date-time
                    description: Timestamp when the domain was added
                required:
                  - id
                  - domain
                  - status
                  - verified
                  - verificationCooldownUntil
                  - verificationToken
                  - verificationMethod
                  - dkimSelector
                  - dkimPublicKey
                  - spfConfigured
                  - dmarcConfigured
                  - mxConfigured
                  - feedbackEnabled
                  - records
                  - createdAt
                description: >-
                  Full domain resource representation with verification and DNS
                  status
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token obtained from authentication. Pass as: Authorization:
        Bearer <token>
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for programmatic access. Pass as: X-API-Key: <your-key>'

````