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

# Create a sending domain

> Registers a domain and generates the DNS records that must be published before it can send. Requires the `domains:write` scope.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/user/sending-domains
openapi: 3.0.0
info:
  title: Brudcast API
  version: 1.0.0
servers:
  - url: https://core-service.prod.brudcast.com
    description: Production
security: []
tags:
  - name: Analytics
    x-displayName: Analytics
  - name: Campaigns
    x-displayName: Campaigns
  - name: Contacts
    x-displayName: Contacts
  - name: Mailboxes
    x-displayName: Mailboxes
  - name: Messages
    x-displayName: Messages
  - name: Sender Identities
    x-displayName: Sender Identities
  - name: Sending Domains
    x-displayName: Sending Domains
  - name: Templates
    x-displayName: Templates
  - name: Webhooks
    x-displayName: Webhooks
paths:
  /api/v1/user/sending-domains:
    post:
      tags:
        - Sending Domains
      summary: Create a sending domain
      description: >-
        Registers a domain and generates the DNS records that must be published
        before it can send. Requires the `domains:write` scope.
      parameters:
        - in: header
          name: X-Organization-Id
          required: false
          description: >-
            Required when authenticating with an access token. Optional with an
            API key, whose own organization binding is authoritative; a value
            contradicting it is refused with 403.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                domain:
                  type: string
                  minLength: 2
              required:
                - domain
              additionalProperties: false
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                  data:
                    $ref: '#/components/schemas/SendingDomainObject'
                required:
                  - success
                  - message
                  - data
        '400':
          description: The domain is already registered to the organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The credential is missing, malformed, revoked or expired
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            The key lacks the scope the endpoint requires, or the organization
            does not match the credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The payload or query string failed validation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '429':
          description: >-
            Rate limit exceeded; retry after the number of seconds in
            `retryAfter`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitErrorResponse'
      security:
        - apiKey: []
        - apiKeyBearer: []
components:
  schemas:
    SendingDomainObject:
      type: object
      properties:
        id:
          type: string
          format: uuid
        cuid:
          type: string
          description: Stable public identifier for the domain
        organizationId:
          type: string
          format: uuid
        name:
          type: string
          example: mail.example.com
        status:
          type: string
          enum:
            - provisioning
            - provisioning_failed
            - unverified
            - verified
            - verification_failed
            - suspended
        verifiedAt:
          type: string
          format: date-time
          nullable: true
        lastVerificationAttempt:
          type: string
          format: date-time
          nullable: true
        verificationAttempts:
          type: number
        dkimEnabled:
          type: boolean
        spfEnabled:
          type: boolean
        dmarcEnabled:
          type: boolean
        trackingEnabled:
          type: boolean
        trackingHostname:
          type: string
          example: track.example.com
        clickTrackingEnabled:
          type: boolean
        openTrackingEnabled:
          type: boolean
        unsubscribesEnabled:
          type: boolean
        returnPathEnabled:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        domainDnsRecords:
          type: array
          items:
            $ref: '#/components/schemas/DomainDnsRecordObject'
      required:
        - id
        - cuid
        - organizationId
        - name
        - status
        - verifiedAt
        - lastVerificationAttempt
        - verificationAttempts
        - dkimEnabled
        - spfEnabled
        - dmarcEnabled
        - trackingEnabled
        - trackingHostname
        - clickTrackingEnabled
        - openTrackingEnabled
        - unsubscribesEnabled
        - returnPathEnabled
        - createdAt
        - updatedAt
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Resource not found
        code:
          type: string
          enum:
            - E_VALIDATION_ERROR
            - E_UNAUTHORIZED_ACCESS
            - E_UNAUTHORIZED
            - E_FORBIDDEN
            - E_INSUFFICIENT_SCOPE
            - E_ROW_NOT_FOUND
            - E_TOO_MANY_REQUESTS
            - E_BUSINESS_RULE_VIOLATION
            - E_CAMPAIGN_NOT_SENDABLE
            - INSUFFICIENT_CREDITS
            - SUBSCRIPTION_REQUIRED
          example: E_ROW_NOT_FOUND
      required:
        - success
        - message
        - code
    ValidationErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: The payload is invalid
        code:
          type: string
          enum:
            - E_VALIDATION_ERROR
            - E_UNAUTHORIZED_ACCESS
            - E_UNAUTHORIZED
            - E_FORBIDDEN
            - E_INSUFFICIENT_SCOPE
            - E_ROW_NOT_FOUND
            - E_TOO_MANY_REQUESTS
            - E_BUSINESS_RULE_VIOLATION
            - E_CAMPAIGN_NOT_SENDABLE
            - INSUFFICIENT_CREDITS
            - SUBSCRIPTION_REQUIRED
          example: E_VALIDATION_ERROR
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
      required:
        - success
        - message
        - code
        - errors
    RateLimitErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Too many requests
        code:
          type: string
          enum:
            - E_VALIDATION_ERROR
            - E_UNAUTHORIZED_ACCESS
            - E_UNAUTHORIZED
            - E_FORBIDDEN
            - E_INSUFFICIENT_SCOPE
            - E_ROW_NOT_FOUND
            - E_TOO_MANY_REQUESTS
            - E_BUSINESS_RULE_VIOLATION
            - E_CAMPAIGN_NOT_SENDABLE
            - INSUFFICIENT_CREDITS
            - SUBSCRIPTION_REQUIRED
          example: E_TOO_MANY_REQUESTS
        retryAfter:
          type: number
          example: 60
      required:
        - success
        - message
        - code
        - retryAfter
    DomainDnsRecordObject:
      type: object
      properties:
        id:
          type: string
          format: uuid
        sendingDomainId:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - TXT
            - CNAME
            - MX
        name:
          type: string
          example: brudcast._domainkey.example.com
        value:
          type: string
          example: v=DKIM1; k=rsa; p=MIGfMA0...
        purpose:
          type: string
          enum:
            - verification
            - dkim
            - spf
            - dmarc
            - tracking
            - mx
            - autoconfig
            - autodiscover
            - srv
        description:
          type: string
          nullable: true
        priority:
          type: number
          nullable: true
          example: 10
        ttl:
          type: number
          example: 3600
        isVerified:
          type: boolean
        scope:
          type: string
          enum:
            - sending
            - mailbox
            - shared
        verifiedAt:
          type: string
          format: date-time
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - sendingDomainId
        - type
        - name
        - value
        - purpose
        - description
        - priority
        - ttl
        - isVerified
        - scope
        - verifiedAt
        - createdAt
        - updatedAt
    ValidationErrorItem:
      type: object
      properties:
        field:
          type: string
          example: emailAddress
        rule:
          type: string
          example: email
        message:
          type: string
          example: The emailAddress field must be a valid email address
      required:
        - field
        - rule
        - message
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        An organization API key, prefixed `bk_live_`. Takes precedence over
        `Authorization` when both are sent. The key is bound to one
        organization, and the scopes it was issued with are enforced per
        endpoint.
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: bk_live_...
      description: >-
        The same organization API key sent as `Authorization: Bearer
        bk_live_...`. Accepted only when the value begins with `bk_` and no
        `X-API-Key` header is present.

````