PingOne Platform APIs

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. Refer also to Notifications, especially Trusted Email Domains.

Request Model
Property Type Required?

emailAddress

String

Required

Refer to the Trusted email addresses data model for full property descriptions.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "emailAddress": "noreply1@auth.shopco.com"
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data-raw '{
    "emailAddress": "noreply1@auth.shopco.com"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""emailAddress"": ""noreply1@auth.shopco.com""" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails"
  method := "POST"

  payload := strings.NewReader(`{
    "emailAddress": "noreply1@auth.shopco.com"
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
POST /environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "emailAddress": "noreply1@auth.shopco.com"
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"emailAddress\": \"noreply1@auth.shopco.com\"\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "emailAddress": "noreply1@auth.shopco.com"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "emailAddress": "noreply1@auth.shopco.com"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails"

payload = json.dumps({
  "emailAddress": "noreply1@auth.shopco.com"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "emailAddress": "noreply1@auth.shopco.com"\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "emailAddress": "noreply1@auth.shopco.com"
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"emailAddress\": \"noreply1@auth.shopco.com\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

201 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"
}