Home
/
API reference
/
API documentation (JSON/XML)
/
Tasks
/
Domain cancelation tasks

Domain cancelation update

API reference (XML/JSON) · Updated 2023-09-18

Function

The DomainCancelationUpdate task updates a cancelation job. You can use this job type to change e.g. the type (DELETE, TRANSIT,PREACK) or the execution time.

Behavior with existing AuthInfo

When processing a cancelation request of the type PREACK, an existing AuthInfo1 is always deleted, regardless of what is changed. If the new order is again of the type PREACK, then a new AuthInfo1 is automatically created.

Description

Route: PUT /domain/{name}/cancelation

{
    "domain": "example.com",
    "type": "DELETE",
    "execution": "DATE",
    "registryWhen": "2020-01-09T12:00:00",
	"disconnect": true
}

{
    "stid": "20190701-app3-dev-9615",
    "messages": [
        {
            "text": "The task will be executed at the given date.",
            "code": "MSG010316",
            "status": "NOTICE"
        }
    ],
    "status": {
        "code": "S0103102",
        "text": "Domain cancelation was updated successfully.",
        "type": "SUCCESS"
    },
    "object": {
        "type": "DomainCancelation",
        "value": "example.com"
    },
    "data": [
        {
            "created": "2019-07-01T10:38:56.000+0200",
            "updated": "2019-07-01T10:38:56.000+0200",
            "owner": {
                "context": 4,
                "user": "customer"
            },
            "updater": {
                "context": 4,
                "user": "customer"
            },
            "domain": "example.com",
            "registryWhen": "2020-01-09T12:00:00.000+0100",
            "disconnect": false,
            "logId": 245138,
            "type": "DELETE",
            "execution": "DATE"
        }
    ]
}

Task code: 0103102
Uses Cancelation object

<request>
	<auth>
		<user>customer</user>
		<password>password</password>
		<context>4</context>
	</auth>
	<task>
		<code>0103102</code>
		<cancelation>
			<domain>example.com</domain>
			<type>delete</type>
			<execdate>2010-02-01</execdate>
			<disconnect>1</disconnect>
		</cancelation>
		<reply_to>customer@example.com</reply_to>
		<ctid>customer-transaction-id</ctid>
	</task>
</request>

<response>
    <result>
        <data>
            <cancelation>
                <execdate>2020-02-01 00:00:00</execdate>
                <changed>2019-10-07 10:47:44</changed>
                <domain>example.com</domain>
                <type>DELETE</type>
                <registry_when_date>2020-02-01 00:00:00</registry_when_date>
                <log_id>1219747</log_id>
                <created>2019-09-07 10:47:44</created>
            </cancelation>
        </data>
        <msg>
            <text>The task will be executed at the given date.</text>
            <code>MSG010316</code>
            <type>notice</type>
        </msg>
        <status>
            <code>S0103102</code>
            <text>Domain cancelation was updated successfully.</text>
            <type>success</type>
            <object>
                <type>domain</type>
                <value>example.com</value>
            </object>
        </status>
    </result>
    <stid>20191007-app-82241</stid>
</response>