Tracking Domains

📘

Do you have any questions on our Email API? Write to us at [email protected]

/settings/addTrackingDomain

Adds a new tracking domain to the account.

Example Request

{
    "owner_id": "example id",
    "token": "example token",
    "domain": "delivery.example.com"
}

Example Success Response

{
    "status": "success",
    "message": "Tracking Domain Added"
}

Example Error Response

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters

*compulsory field

Return Value: Success

struct — the results of adding a tracking domain

Return Value: Error

struct — the error results when attempting to add a tracking domain

Error Types

ValidationError — The parameters passed to the API call are invalid or not provided when required.

GeneralError — An unexpected error occurred processing the request. SendClean Developers will be notified.

AuthenticationError — Provided owner_id and token was not matched.

/settings/checkTrackingDomain

Validates tracking domain configuration and CNAME records.

Example Request

{
    "owner_id": "example id",
    "token": "example token",
    "domain": "delivery.example.com"
}

Example Success Response

{
    "status": "success",
    "cname_valid": true
}

Example Error Response

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters

*compulsory field

Return Value: Success

struct — the results of checking a tracking domain

Return Value: Error

struct — the error results when attempting to check a tracking domain

Error Types

ValidationError — The parameters passed to the API call are invalid or not provided when required.

GeneralError — An unexpected error occurred processing the request. SendClean Developers will be notified.

AuthenticationError — Provided owner_id and token was not matched.

/settings/listTrackingDomain

Retrieves all tracking domains associated with the account.

Example Request

{
    "owner_id": "example id",
    "token": "example token"
}

Example Success Response

{
    "status": "success",
    "domain_data": [
        {
            "domain": "delivery.example.com",
            "create_date": 1458034022169,
            "cname_valid": true
        }
    ]
}

Example Error Response

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters

*compulsory field

Return Value: Success

struct — the results of listing tracking domains

**domain_data[]**fields:

Return Value: Error

struct — the error results when attempting to list tracking domains

Error Types

ValidationError — The parameters passed to the API call are invalid or not provided when required.

GeneralError — An unexpected error occurred processing the request. SendClean Developers will be notified.

AuthenticationError — Provided owner_id and token was not matched.

/settings/deleteTrackingDomain

Removes a tracking domain from the account.

Example Request

{
    "owner_id": "example id",
    "token": "example token",
    "domain": "delivery.example.com"
}

Example Success Response

{
    "status": "success",
    "message": "Tracking Domain Deleted"
}

Example Error Response

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters

*compulsory field

Return Value: Success

struct — the results of deleting a tracking domain

Return Value: Error

struct — the error results when attempting to delete a tracking domain

Error Types

ValidationError — The parameters passed to the API call are invalid or not provided when required.

GeneralError — An unexpected error occurred processing the request. SendClean Developers will be notified.

AuthenticationError — Provided owner_id and token was not matched.