API: Add Custom Automation Task

addCustomAutomationTask

Add a new custom automation task to an account or domain. Tasks can be event-based (triggered before/after a specific event) or scheduled for a specific datetime.

Required parameters

Parameter	Description
type	Entity type: Hosting or Domain
id	Account or domain ID
task	Task type name (e.g. sendEmail, suspendAccount, recalculateRecurringPrice)

Optional parameters

Parameter	Description
execute_type	Set to execute_datetime to run the task once at a specific date and time.
execute_date	Required when execute_type=execute_datetime. Execution date (format: YYYY-MM-DD)
execute_time	Required when execute_type=execute_datetime. Execution time (format: HH:MM:SS)
when	Required for event-based tasks (when execute_type is not set). Timing relative to the event: before or after
what_before	Required when when=before. Name of the event that triggers the task (e.g. AccountDueDate, UnpaidInvoice)
what_after	Required when when=after. Name of the event that triggers the task (e.g. InvoicePaid, AccountCreate)
days	Used for event-based tasks only. Interval value — how many units before/after the event to execute (default: 1)
interval_type	Used for event-based tasks only. Interval unit: DAY, HOUR, MINUTE, ONCE (default: DAY)
config	Task-specific configuration array (e.g. config[email_id]=5)
conditions	Optional execution conditions Each rule requires: id (field name), field (same as id), type (string

Request

GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=addCustomAutomationTask&type=TYPE&id=ID&task=TASK

PHP Samples

PHP Samples: Add event-based task

PHP Samples: Add datetime-scheduled task

PHP Samples: Add event-based task with conditions

Response

{
    "success": true,
    "info": [
        "new_task_created"
    ],
    "call": "addCustomAutomationTask",
    "server_time": 1700000000
}