CountdownMail API

API Conventions

• /something is equivalent to /something/.

• URL paths, URL query parameter names, and JSON field names are case sensitive.

• URL paths use lower case, with dashes separating words.

• Query parameters and JSON fields use lower case, with underscores separating words.

• The HTTP status indicates whether an operation failed or succeeded, with extra information included in the HTTP response body.

• All APIs return standard error code formats.

• Unexpected query parameters are ignored.

• Unexpected JSON fields in the request body are ignored.

• The JSON number type is bounded to a signed 32-bit integer.

API Endpoint

 https://countdownmail.com/api
    

Authentication

• To authenticate with the APIs, specify the "Authorization" header with each request. The value of the Authorization header must be a valid API key or basic auth with the API key as username and an empty password. Get a CountdownMail API key.

• For examples of supplying the Authorization header, refer to the cURL example below or any of the individual API request examples.

Using Postman

If you use Postman you can click the following button to import the CountdownMail API as a collection:

Using cURL

If you are using cURL to call the API, you must include the resource URI in quotes when you pass in multiple query parameters separated by an &.

For example:

curl -v \
-H "Content-Type: application/json" \
-H "Authorization: wEw476d2e5b1d2bad079bf5bbf5b1d22" \
-X GET "https://countdownmail.com/api/deactivate/1g"

Errors

When you make an API call you may receive an error message in response. Either there is something wrong with your request or something went wrong on our end. Errors respond with an error code and JSON that contains a more precise message.

Example Error (HTTP status code: 401)

{
    "status": "error",
    "message": "Unauthorized"
}

Countdown Timer Create

POST /create

These are the valid request options for Create a countdown timer:

{
    "separator_color"  : "4275BC",
    "separator_size" : 1.3,
    "separator_style" : 6,
    "labels_color" : "A3A3A3"
}

Examples

Request: POST /create

{
    "skin_id":3,
    "name":"Big Sale!",
    "time_end":"2024-11-22 00:49:58",
    "time_zone":"America\/Los_Angeles",
    "font_family":"Roboto-Bold",
    "color_primary":"FF3A43",
    "color_text":"FFFFFF",
    "color_bg":"000000",
    "transparent":"0",
    "lang_local":"0",
    "font_size":"38",
    "day":"1",
    "lang":"en",
    "expired_mes_on":"1",
    "expired_mes":"This offer has expired",
    "labels":"1",
    "days":"days",
    "hours":"hours",
    "minutes":"minutes",
    "seconds":"seconds"
}

Response: (HTTP status code: 200)

{
    "status": "success",
    "message": {
        "code": "td",
        "src": "http://i.countdownmail.com/td.gif"
}

Countdown Timer Update

POST /update/{code}

Examples

Request: POST /update/1j

{
    "skin_id":3,
    "name":"Big Sale!",
    "time_end":"2024-11-22 07:13:31",
    "time_zone":"America\/Los_Angeles",
    "font_family":"Roboto-Bold",
    "color_primary":"FF3A43",
    "color_text":"FFFFFF",
    "color_bg":"000000",
    "transparent":"0",
    "lang_local":"0",
    "font_size":"38",
    "day":"1",
    "lang":"en",
    "expired_mes_on":"1",
    "expired_mes":"This offer has expired",
    "labels":"1",
    "days":"days",
    "hours":"hours",
    "minutes":"minutes",
    "seconds":"seconds"
}

Response: (HTTP status code: 200)

{
    "status": "success",
    "message": {
        "code": "td",
        "src": "http://i.countdownmail.com/td.gif"
}

Countdown Timer Duplicate

POST /duplicate/{code}

Countdown Timer Deactivate

GET /deactivate/{code}

Countdown Timer Activate

GET /activate/{code}