Register Domain

Information

URL: https://api.emailyak.com/v1/private_api_key/json/register/domain/
Request type: POST
Request Content-Type: application/json
Response Content-Type: application/json; charset=utf-8

Input JSON Example

Input

Domain - a string containing a domain. Email Addresses can then be created to send & receive email using Email Yak.

CallbackURL (optional) - a string containing a URL. A POST request will be sent to the address provided with information about the email received. If a CallbackURL is specified for both the domain and an address, only the Address CallbackURL will be sent a POST request. Read more about Push Notifications.

PushEmail (optional, default is false) - a boolean containing a true or false value (True / False, true / false, or 1 / 0 are acceptable values). If true, the full contents of the email will be pushed, via HTTP POST, to the CallbackURL. Read more about Push Email. 

Output

Status - the status code for the response. Read more about status codes.

Message - a short message with information about your request. If there was an error, a short description of the error will be provided.

Input JSON Example

{
	"Domain": "example.com",
	"CallbackURL": "http://example.com/push_notifications/",
	"PushEmail": True
}

Output JSON Example

{
	"Status": 200,
	"Message": "Success"
}

Notes

• Domain Ownership verification is required before any emails will be sent or received.