- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- Domain cancelation tasks
Domain cancelation create
Function
The DomainCancelationCreate task creates a domain cancelation.
Description
The keyword description of the domain element can be found on the Cancelation Object page.
The description of the cancelation status can be found on Cancelation Status Constants page.
Route: POST /domain/{name}/cancelation
{
"domain": "example.com",
"disconnect": false,
"type": "DELETE",
"execution": "EXPIRE"
}{
"stid": "20190701-app3-dev-9689",
"messages": [
{
"text": "The task will be executed at domain expiration.",
"code": "MSG010315",
"status": "NOTICE"
}
],
"status": {
"code": "N0103101",
"text": "Domain cancelation task was transmitted.",
"type": "NOTIFY"
},
"object": {
"type": "DomainCancelation",
"value": "example.com"
},
"data": [
{
"created": "2019-07-01T10:44:26.000+0200",
"updated": "2019-07-01T10:44:26.000+0200",
"owner": {
"context": 4,
"user": "exampleuser"
},
"updater": {
"context": 4,
"user": "exampleuser"
},
"domain": "example.com",
"registryWhen": "2019-08-17T14:27:31.000+0200",
"disconnect": false,
"logId": 245139,
"type": "DELETE",
"execution": "EXPIRE"
}
]
}
Task code: 0103101
Uses Cancelation object.
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>0103101</code>
<cancelation>
<domain>example.com</domain>
<type>delete</type>
<execdate>expire</execdate>
<disconnect>1</disconnect>
<gaining_registrar></gaining_registrar>
</cancelation>
<reply_to>customer@example.com</reply_to>
</task>
</request><response>
<result>
<data>
<cancelation>
<execdate>now</execdate>
<changed>2018-02-13 15:19:45</changed>
<domain>example.com</domain>
<type>DELETE</type>
<registry_when_date>2018-02-13 15:19:44</registry_when_date>
<log_id>186467</log_id>
<created>2018-02-13 15:19:44</created>
</cancelation>
<domain_job>
<job>
<id>4295210830</id>
</job>
</domain_job>
</data>
<status>
<code>N0103</code>
<text>Domain deletion has been started successfully.</text>
<type>notify</type>
<object>
<type>domain</type>
<value>example.com</value>
</object>
</status>
</result>
<stid>20180213-app1-6072</stid>
</response>