Overview

This API endpoint enables you to add a domain to our platform via an API call. Once added, the platform will send a domain verification email to the email address listed in the API call, so the domain can be verified, just like you’d do if you added and verified a domain manually in our platform.

The Method

API Method
REST GET https://[Your URL]/api/3.0/domains/create

Parameters

Required Parameters
Property Type Description Default Required Read Only
domain_verification_email string Email address containing the domain to verify as well as where the notification will be sent None Yes

Code Samples

Example Request
curl -X POST \
  <URL>/api/3.0/domains/create \
  -H 'Authorization: Basic <auth header>\
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -d '{
    "domain_verification_email": example@mydomain.co.za
   }'
Example Response
{
  "result": "success",
  "data": {
    "messages": [
      "Domain Created",
      "A verification message has been sent"
    ],
    "domain": {
      "domain_domain": "mydomain.co.za",
      "domain_sending_verified": "no"
    }
  }
}