/settings/addTrackingDomain
Add a new Tracking Domains
Example Request JSON
{
"owner_id": "example id",
"token": "example token",
"domain": "abc.com",
}
Example Response JSON
{
"status": "success",
"message": "Tracking Domain Added",
}
Example Error Response JSON
{
"status": "error",
"code": "-1",
"name": "AuthenticationError",
"message": Token MissMatch,
}
| Parameters |
| owner_id* string |
a valid PowerEmailUser Id |
| token* string |
a valid token |
| domain* integer |
domain name |
* compulsory field
| Return Value: Success |
| struct |
the results of newly Added Domain
| status string |
always success |
| message string |
human readable message |
|
|
| Return Value: Error |
| struct |
the error results when attempt to add domain
| statusstring |
error |
| messagestring |
human readable message |
| type string |
one of the error type as bellow table |
|
|
| Error types |
| ValidationError |
The parameters passed to the API call are invalid or not provided when required. |
| GeneralError |
An unexpected errors occurred processing the request. PowerEmailDevelopers will be notified. |
| AuthenticationError |
Provided owner_id and token was not matched. |
/settings/checkTrackingDomain
check Tracking Domain
Example Request JSON
{
"owner_id": "example id",
"token": "example token",
"domain": "abc.com",
}
Example Response JSON
{
"status": "success",
"domain": "abc.com",
"valid_tracking": "Yes",
"cname": {
"valid": "Yes",
}
}
Example Error Response JSON
{
"status": "error",
"code": "-1",
"name": "AuthenticationError",
"message": Token MissMatch,
}
| Parameters |
| owner_id* string |
a valid PowerEmailUser Id |
| token* string |
a valid token |
| domain* string |
doamin name |
* compulsory field
| Return Value: Success |
| struct |
the results of check Tracking Domain
| status string |
always success |
| message string |
human readable message |
| valid_tracking string |
value is Either 'Yes' OR 'No' |
| cname[]struct |
cname validation result
| valid string |
value is either 'Yes' OR 'No' |
|
|
|
| Return Value: Error |
| struct |
the error results when attempt check Tracking Domain
| statusstring |
error |
| messagestring |
human readable message |
| type string |
one of the error type as bellow table |
|
|
| Error types |
| ValidationError |
The parameters passed to the API call are invalid or not provided when required. |
| GeneralError |
An unexpected errors occurred processing the request. PowerEmailDevelopers will be notified. |
| AuthenticationError |
Provided owner_id and token was not matched. |
/settings/listTrackingDomain
List Tracking Domain
Example Request JSON
{
"owner_id": "example id",
"token": "example token",
}
Example Response JSON
{
"status": "success",
"tracking_domain_list":[
{
"domain": "abc.com",
"create_date": "67457775764",
"cname": {
"valid": "Yes",
}
},
{
"domain": "xyz.com",
"create_date": "67457775891",
"cname": {
"valid": "Yes",
}
}
]
}
Example Error Response JSON
{
"status": "error",
"code": "-1",
"name": "AuthenticationError",
"message": Token MissMatch,
}
| Parameters |
| owner_id* string |
a valid PowerEmailUser Id |
| token* string |
a valid token |
* compulsory field
| Return Value: Success |
| struct |
the results of List Tracking Domain
| status string |
always success |
| message string |
human readable message |
| tracking_domain_list[]struct |
information of single Tracking Domain
| domain string |
domain name |
| create_date integer |
create date in micro seconds |
| cname[]struct |
cname validation result
| valid string |
value is Either 'Yes' OR 'No' |
|
|
|
|
|
| Return Value: Error |
| struct |
the error results when attempt to List Tracking Domain
| status string |
error |
| message string |
human readable message |
| type string |
one of the error type as bellow table |
|
|
| Error types |
| ValidationError |
The parameters passed to the API call are invalid or not provided when required. |
| GeneralError |
An unexpected errors occurred processing the request. PowerEmailDevelopers will be notified. |
| AuthenticationError |
Provided owner_id and token was not matched. |
/settings/deleteTrackingDomain
Delete Tracking Domain
Example Request JSON
{
"owner_id": "example id",
"token": "example token",
"domain": "abc.com",
}
Example Response JSON
{
"status": "success",
"message": "Tracking Domain Deleted",
}
Example Error Response JSON
{
"status": "error",
"code": "-1",
"name": "AuthenticationError",
"message": Token MissMatch,
}
| Parameters |
| owner_id* string |
a valid PowerEmailUser Id |
| token* string |
a valid token |
| domain* string |
domain name |
* compulsory field
| Return Value: Success |
| struct |
the results of Delete Tracking domain
| status string |
always success |
| message string |
human readable message |
|
|
| Return Value: Error |
| struct |
the error results when attempt to Delete Tracking Domain
| status string |
error |
| message string |
human readable message |
| type string |
one of the error type as bellow table |
|
|
| Error types |
| ValidationError |
The parameters passed to the API call are invalid or not provided when required. |
| GeneralError |
An unexpected errors occurred processing the request. PowerEmailDevelopers will be notified. |
| AuthenticationError |
Provided owner_id and token was not matched. |
