---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Email domains"
description: "The `email_domains` collection of Sylphx Auth: An Email Domain is an email domain a customer organization claims."
type: reference
product: organizations
summary: "An Email Domain is an email domain a customer organization claims."
updated: 2026-09-28
order: 900
---

An Email Domain is an email domain a customer organization claims. It is verified by a DNS TXT record; a verified domain appears in the organization's `verified_domains`, and one environment's organizations never verify the same domain twice.

**Service** Sylphx Auth · **Resource type** `auth.sylphx.com/EmailDomain` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/customer_organizations/{customer_organization}/email_domains/{email_domain}` · **Shape** `record`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/customer_organizations/{customer_organization}/email_domains/{email_domain}`. |
| `uid` | `string` | `dom_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `domain` | `string` | The domain, lowercase, for example `acme.com`. Required. |
| `state` | `EmailDomainState` | The verification state. Output only. One of `pending`, `verified`. |
| `verification_record` | `string` | The TXT record name to publish, `_sylphx-verification.<domain>`. Output only. |
| `verification_value` | `string` | The TXT record value to publish. Output only. |
| `verify_time` | `timestamp` | When the record was last found. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/email_domains#get) | Gets an email domain. |
| `GET` | [`list`](/docs/api/email_domains#list) | Lists email domains. |
| `POST` | [`create`](/docs/api/email_domains#create) | Creates an email domain; the answer names the TXT record to publish. |
| `DELETE` | [`delete`](/docs/api/email_domains#delete) | Deletes an email domain. |
| `POST` | [`verify`](/docs/api/email_domains#verify) | Looks up the domain's TXT record now; found, the domain is verified. |

## get

Gets an email domain.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/email_domains/email-domain` · scope `auth:read` · effect `read` · [Request, response and examples](/docs/api/email_domains/get)

## list

Lists email domains.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/email_domains` · scope `auth:read` · effect `read` · paginated · [Request, response and examples](/docs/api/email_domains/list)

## create

Creates an email domain; the answer names the TXT record to publish.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/email_domains` · scope `auth:write` · effect `write` · [Request, response and examples](/docs/api/email_domains/create)

## delete

Deletes an email domain.

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/email_domains/email-domain` · scope `auth:write` · effect `destructive` · [Request, response and examples](/docs/api/email_domains/delete)

## verify

Looks up the domain's TXT record now; found, the domain is verified.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/email_domains/email-domain:verify` · scope `auth:write` · effect `write` · [Request, response and examples](/docs/api/email_domains/verify)