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

# Create an email address

> Provision a vanity address such as vita@yorlet.email.



## OpenAPI

````yaml openapi-core.json POST /v1/email_addresses
openapi: 3.1.0
info:
  title: Yorlet Core API
  description: Core platform APIs including buildings, customers, units, and tasks.
  version: 1.0.0
servers:
  - url: https://api.yorlet.com
    description: Production
  - url: https://api.yorlet.io
    description: Sandbox
security: []
paths:
  /v1/email_addresses:
    post:
      tags:
        - Email addresses
      summary: Create an email address
      description: Provision a vanity address such as vita@yorlet.email.
      operationId: email_addresses_create
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                local_part:
                  type: string
                  minLength: 1
                  maxLength: 64
                  description: >-
                    The local-part to provision, e.g. `vita` for
                    vita@yorlet.email.
                domain:
                  type: string
                  description: >-
                    The domain to use. Defaults to the Yorlet-managed domain.
                    Must be a verified custom domain when set.
                display_name:
                  type: string
                  maxLength: 120
                  description: The display name used in the From header.
                agent:
                  type: boolean
                  description: >-
                    Set this address as the agent’s sending identity. Defaults
                    to true when it is the account’s first address.
                match_priority:
                  type: string
                  enum:
                    - customer
                    - owner
                  description: >-
                    Which party to match first when an inbound sender could be a
                    customer or an owner. Defaults to `customer`.
              required:
                - local_part
      responses:
        '200':
          description: Returns the email address object.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique identifier for the object.
                  created:
                    type: number
                    description: >-
                      Time at which the object was created. Measured in seconds
                      since the Unix epoch.
                  account:
                    type: string
                    description: >-
                      The account that the object belongs to. Only returned if
                      the request is made with a valid Yorlet-Context header.
                  deleted:
                    type: boolean
                    default: false
                    description: Only returned if the object has been deleted.
                  object:
                    type: string
                    enum:
                      - email_address
                  address:
                    type: string
                    description: The full email address, lowercase.
                  agent:
                    type: boolean
                    description: >-
                      Whether this is the address the agent sends from. At most
                      one address per account may be flagged.
                  display_name:
                    type:
                      - string
                      - 'null'
                    description: The display name used in the From header.
                  domain:
                    type: string
                    description: The domain portion of the address.
                  local_part:
                    type: string
                    description: The local-part portion of the address.
                  match_priority:
                    type: string
                    enum:
                      - customer
                      - owner
                    description: >-
                      Which party to match first when an inbound sender could be
                      a customer or an owner. Defaults to `customer`.
                required:
                  - id
                  - created
                  - object
                  - address
                  - agent
                  - display_name
                  - domain
                  - local_part
                  - match_priority
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API Key authentication. Use "Bearer YOUR_API_KEY".

````