Get account domain
GET /account-domains/:accountDomainRef
Lists the account domain properties. Check the ‘active’ flag is set to ‘1’ for domain ready.
Parameters
| accountDomainRef integer | Required. The account domain ref. |
Response
Status: 200 OK
{
"accountDomain": {
"domainName": "johnsmith.co.uk",
"domainRegistered": {
"date": "2015-11-16 15:16:42.000000",
"timezone_type": 3,
"timezone": "Europe/London"
},
"expiryDate": {
"date": "2016-11-19 15:16:42.000000",
"timezone_type": 3,
"timezone": "Europe/London"
},
"active": 1,
"autoRenew": 1,
"ref": 1,
"accountHolder": {...},
"domainProduct": {...},
"dnsProvider": {
"ref": 4
}
}Get account domains
GET /users/:accountHolderRef/account-domains
List all domains for the account holder.
Parameters
| accountHolderRef integer | Required. The account holder ref. |
Response
Status: 200 OK
{
"accountDomains": [
{
"ref": 1,
"name": "johnsmith.co.uk",
"renewalDate": {
"date": "2016-11-19 15:16:42.000000",
"timezone_type": 3,
"timezone": "Europe/London"
},
"autoRenew": 1,
"isFree": false,
"active": 1,
"domainRegistered": {
"date": "2015-11-16 15:16:42.000000",
"timezone_type": 3,
"timezone": "Europe/London"
},
"expiryDate": {
"date": "2016-11-19 15:16:42.000000",
"timezone_type": 3,
"timezone": "Europe/London"
},
"domainProduct": {...},
"accountPackage": {...}
}
]
}Get mailboxes
GET /users/:accountHolderRef/domains/mailboxes
List all domain mailboxes associated to the account holder.
Parameters
| accountHolderRef integer | Required. The account holder ref. |
Response
Status: 200 OK
{
"domainMailboxes": []
}Get domain mailboxes
GET /users/:accountHolderRef/domains/:accountDomainRef/mailboxes
List all mailboxes attached the account holders domain.
Parameters
| accountHolderRef integer | Required. The account holder ref. |
| accountDomainRef integer | Required. The account holder domain ref. |
Response
Status: 200 OK
{
"mailboxes": []
}Add domain mailbox
PUT /users/:accountHolderRef/domains/:accountDomainRef/mailboxes/:user
Creates a user/mailbox for the account domain.
Parameters
| accountHolderRef integer | Required. The account holder ref. |
| accountDomainRef integer | Required. The account holder domain ref. |
| user string | Required. The mailbox user name. |
| password string | Required. The mailbox users password. |
Content-Type: application/json
{
"password": "imakebeer"
}Response
Status: 200 OK
{
"mailbox": [
{
"user": "newuser@myaccountdomain.co.uk",
"status": "pending"
}
}Delete domain mailbox
DELETE /users/:accountHolderRef/domains/:accountDomainRef/mailboxes/:user
Deletes a mailbox for the account domain.
Parameters
| accountHolderRef integer | Required. The account holder ref. |
| accountDomainRef integer | Required. The account holder domain ref. |
| user string | Required. The mailbox user name. |
Response
Status: 204 No Content
Get mailbox login token
POST /users/:accountHolderRef/domains/:accountDomainRef/mailboxes/:user/login-tokens
Create a login token for account domain mailbox.
Parameters
| accountHolderRef integer | Required. The account holder ref. |
| accountDomainRef integer | Required. The account holder domain ref. |
| user string | Required. The mailbox user name. |
Response
Status: 200 OK
{
"loginToken": "asldjfao4eut8udofjlkajsdf"
}Forgotten Password
POST /users/forgotten-password
The forgotten password API call accepts either the account holders username or email address and a loginLink URL. An email is sent to the account holder with a link to reset the password.
Parameters
| username string | Required. The account holder username (not required parameter if email is set). |
| email string | Required. The account holder email address (not required parameter if username is set). |
| loginLink string | Required. A URL which the forgotten password email will use to construct the link for resetting the account holders password. The link will be appended with ?h={hash}. |
Content-Type: application/json
{
"username": "johnsmith",
"email": "johnsmith@mail.co.uk",
"loginLink": "http://www.website.co.uk/reset"
}Response
Status: 204 No Content
Reset Password
POST /users/reset-password
The reset password API call accepts a hash and new password in order to reset the password.
Parameters
| hash string | Required. The hash generated by the forgotten password API call. |
| password string | Required. The new password. |
Content-Type: application/json
{
"hash": "kajhrgiwyrgjalsdkgj98ehgr",
"password": "thenewpassword"
}Response
Status: 204 No Content
Get Package
See the appropriate section in the brand reference.
Setting site information
Setting site information (such as business name or email address) requires two steps:
- Retrieving the correct
profileReffrom the site end-point. - Updating the profile information using
profileRef.
Email verification
POST /users/:ref/send-verification-email
An email will be sent to the account holders email address with a link to verify their address.
To check if an account holder has a verified email address call GET /users/:ref, the emailVerified
parameter in the response will indicate the verification status.
Parameters
| verificationUrl string | Required. URL to include in verification email to complete the process |
Content-Type: application/json
{
"verificationUrl": "https://example.com/verify"
}Response
Status: 204 No Content
Validate token
POST /users/:ref/validate-email-verification-token
Once the user arrives at the verification URL, validate the provided token using this endpoint. Invalid tokens will cause a 400 response.
Parameters
| token string | Required. token parameter provided in querystring |
Content-Type: application/json
{
"token": "J4kawdtfj2FcLcHq9SFyANBVz2BW5ECn"
}Response
Status: 204 No Content
