Create Trusted Email Domain
POST {{apiPath}}/environments/{{envID}}/emailDomains
The POST {{apiPath}}/environments/{{envID}}/emailDomains
operation adds a new resource entity to the specified environment resource.
Note: An environment can have only one configured trusted email domain.
The request body must specify a value for the resource entity's domainName
property, and there cannot be an existing trusted email domain resource associated with the specified environment. If a trusted email domain resource already exists for this environment, the response returns a UNIQUENESS_VIOLATION
error.
Prerequisites
- See Notifications and Trusted Email Domains for important overview information.
Property | Type | Required? |
---|---|---|
domainName | String | Required |
See the Trusted email domains data models for full property descriptions.
Request Body
{"domainName"=>"example.com"}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/emailDomains/0a061690-6d28-42ea-9b4c-4a9da6e85909"},"environment":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"ownership":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/emailDomains/0a061690-6d28-42ea-9b4c-4a9da6e85909/ownership"},"dkim":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/emailDomains/0a061690-6d28-42ea-9b4c-4a9da6e85909/dkim"},"spf":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/emailDomains/0a061690-6d28-42ea-9b4c-4a9da6e85909/spf"}},"id":"0a061690-6d28-42ea-9b4c-4a9da6e85909","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"domainName":"example.com","createdAt":"2024-03-27T11:19:04.923Z","updatedAt":"2024-03-27T11:19:04.923Z"}