Set TLD Expiration Reminder

Create a custom reminder for a Top-Level Domain (TLD) by providing the resource_id in the path and specifying reminder settings in the request body. This endpoint helps ensure critical events like domain expirations or renewals are not missed by triggering notifications in advance based on your configured timeline.

Reminders can be tailored to fire a set number of days before the domain’s expiration or renewal date, ensuring your team or clients have time to take action. These alerts help maintain service continuity, prevent downtime, and support proactive domain management.

Common use cases:
  • Domain expiration tracking — Notify users a few days before a domain is set to expire, allowing time to renew and avoid accidental lapses.
  • Renewal deadline alerts — Send early reminders to stakeholders when domain renewal windows approach, especially for mission-critical domains.
  • Custom domain-related events — Set reminders tied to DNS updates, registrar changes, or legal/compliance events associated with the domain.

You can view and manage current domain configurations via the TLD Settings page.

Authorization: Bearer YOUR_TOKEN

Path Parameters
  • id string
    The unique service ID for which the TLD reminder will be created.
    Example: 'c03b02ec-244f-4d2c-8f68-3910071ed5c8'
Request Body Parameters
  • days_before array of integers
    An array of integers representing how many days before the event the reminder should be triggered.
    Example: [1]
JavaScript
Response codes
const axios = require('axios');

const url = 'https://resource-cmd.api.pinghome.io/v1/{id}/tld/reminder';
const data = { days_before: [1] };

axios.post(url, data, {
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json'
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error(error);
});
ResponseThis section is used to view the possible HTTP response codes returned by the API. These codes indicate the status of a request, such as 201 (Created), 401 (Unauthorized), 409 (Conflict), or 422 (Unprocessable Entity).