Create Trusted Email Address
POST {{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails
The POST {{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails
operation adds a new trusted email address resource entity to trusted email domain resource the specified environment.
A verification code is sent to provided email address, and the response code will be 201 Successfully created
. If the trusted email address already existed and there was an attempt to create it again, the response code will be 200.
Prerequisites
Create a trusted email domain to get an emailDomainID
for the endpoint. See also Notifications, especially Trusted Email Domains.
Property | Type | Required? |
---|---|---|
emailAddress | String | Required |
See the Trusted email addresses data model for full property descriptions.
Request Body
{"emailAddress"=>"noreply1@auth.shopco.com"}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/emailDomains/abe400ab-674d-42ac-9a70-7c911d7bcace/trustedEmails/17665a60-9fc5-40c2-90e3-91494bbe38be"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"emailDomain":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/emailDomains/abe400ab-674d-42ac-9a70-7c911d7bcace"}},"id":"17665a60-9fc5-40c2-90e3-91494bbe38be","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"domain":{"id":"abe400ab-674d-42ac-9a70-7c911d7bcace"},"emailAddress":"noreply1@auth.shopco.com","status":"VERIFICATION_REQUIRED","createdAt":"2020-06-21T14:33:47.511Z","updatedAt":"2020-06-21T14:33:47.511Z","domainId":"abe400ab-674d-42ac-9a70-7c911d7bcace"}