API: OpenSRS

OpenSRS API Guide: Domains and SSL

Welcome to the OpenSRS API guide. Here you will find comprehensive documentation regarding our domain and SSL services. We hope this guide will help you start working with OpenSRS as quickly as possible. If you have any questions or concerns, please do not hesitate to contact [email protected]

Get Started

modify (domain)

Changes information associated with a domain, such as contact info. The
action request message is different depending on the type of modification
being made, and is shown separately for each type.

This command also allows you to set an auto-renew flag for the domain from
which you logged in. If you are using the affected_domains option, you can
set the renewal action flags for all domains in the user's profile.

Request parameters for modify (domain)

Standard parameters

  • action = modify
  • object = domain
  • registrant_ip = valid IP address of the registrant (optional)

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
affect_domainsRequiredFlag indicating the domains to which to apply
the change.

0—Change applies only to the specified
domain.

1—Change applies to all domains linked to this profile.
dataRequiredType of data. Allowed values are:

ca_whois_display_setting—For changes to the CIRA Whois Privacy setting for .CA domains. Only allowed for
individual registrants, including Canadian citizens, Permanent residents, Legal representatives, and Aboriginal peoples.

change_ips_tag— For transfers of .UK domains between registrars. The
domain's domain tag must be changed to that of the gaining registrar in order to transfer a .UK domain.

cira_registrant—Used to change the owner of a .CA domain. Warning: When you include the
cira_registrant parameter, you transfer the ownership of a domain to the specified contact.

contact_info— For contact information changes.

domain_auth_info— For changes to domain-auth-info.

expire_action— For changes to domain renewal action flags. Requires both
auto_renew and let_expire flags to be specified.

forwarding_email— For forwarding feature on .NAME domains (cannot be set if it was missing from the capabilities
in the response to the 'Get User Info'.).

it_whois_display_setting— Used to
enable/disable WHOIS Privacy.

parkpage_state— Enables or disables the parked pages service for a particular
domain.

status— To control the lock state of the

rsp_whois_info— To control 'RSP Info in Whois' feature

status— To control the lock state of the domain.

tld_data— For changes to the tld_data information that is required to satisfy the regional presence and other
requirements of the registry. Used for .ASIA, .COOP, .JOBS, .LV, .MX, .PRO, .RO, .US, ZA; optional for .XXX. If you submit this value, you must also
submit the tld_data array (see below).

whois_privacy_state— Used to enable or disable WHOIS Privacy.

* whois_publicity_state— Used to enable or disable WHOIS Publicity.
domainRequiredThe relevant domain.
tld_dataRequired for
changes to
tld_data values
for .ASIA,
.COOP, .JOBS,
.LV, .MX,
.PRO, .RO, .US,
ZA; optional
for .XXX
An associative array that contains additional information required by the registry, such as the residency of the registrant. If you submit a request that contains this array, you must also include data = tld_data.

Allowed values are:

ced_info—An array that contains Charter Eligibility (CED) information for .ASIA
domains.

ipr_data—Used to make changes to the
ICM information associated with .XXX domains.

it_registrant_info—For changes to the .IT identification information.

nexus—For changes to the .US Nexus information.

professional_data—Used to make changes to the professional designation information that is associated with the .PRO domain.

registrant_extra_info—additional registrant information.

For more information see tld_data.

For data = ca_whois_display_setting

When the data parameter uses the ca_whois_display_setting value, the
following additional parameter can be used:

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
displayRequiredThe setting for the CIRA Whois Privacy.

Allowed values are:

PRIVATE—When a
WHOIS lookup is done on the domain name, do not display personal information.

FULL—When a WHOIS lookup is done on the domain name, display all of the data that is on the WHOIS directory, including name, address, telephone number and email address.

For data = change_ips_tag

When the data parameter uses the change_ips_tag value, the following additional parameter can be used:

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
change_tag_allOptionalFlag to change all domains on the registrant's profile.

0—Change Domain Tag for specified domain only; this is the default.

1—Change Domain Tag for all *.UK domains on this profile.
domainRequiredThe domain whose Domain Tag is being changed.
gaining_registrar_tagRequiredThe Domain Tag of the gaining registrar.
rsp_overrideOptionalFlag to enable or disable the ability of the RSP to override the End User's Domain Tag
change settings.

0—Reseller cannot override End User's Domain Tag change settings.

1—Reseller can change Domain Tag,
regardless of End User's settings.

For data = contact_info

When the data parameter uses the contact_info value, the following
additional parameters can be used.

Note: The contact_info value is not supported for .DK. Use the
update_all_info command to change the contact information for .DK
domains.

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
contact_setRequiredA hash containing the modified contact information of a specific type:

admin
billing
tech
owner

Note: The owner contact for .IT domains has three additional parameters:
entity_type, nationality_code, and reg_code. For information about these
parameters, see .IT contact requirements.

For more information about contact_set values, see
Examples for contact set
org_nameRequiredOrganization name.
report_emailOptionalThe End User's email address to which notification of
success or failure is sent. The notification email is sent on behalf of the reseller.

Note: This parameter can only be specified if
affect_domains is set to '1'

For data = cira_registrant

When the data parameter uses the cira_registrant value, the following
additional parameters can be used:

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
address1OptionalThe new registrant's address. Maximum 64 characters.
address2OptionalThe new registrant's address. Maximum 64 characters.
address3OptionalThe new registrant's address. Maximum 64 characters.
cityOptionalThe new registrant's city. Maximum 64 characters.
countryOptionalThe 2 letter ISO country code.
emailOptionalMaximum 64 characters, validated according to
rfc822.
faxOptionalMaximum 20 characters, in the format +CCC.NNNNNNNNNNxEEEE, where C = country code,
N = phone number, and E = extension (optional).
first_nameRequiredNew registrant's first name.
langOptionalThe registrant's language preference. The default is
English.

Allowed values are:

EN—English
FR—French
last_nameRequiredNew registrant's last name.
legal_typeRequiredThe code that indicates the new registrant's legal classification to satisfy CIRA's Canadian Presence Requirement (CPR).

Allowed values are:

ABO—Aboriginal

ASS—Association

CCO—Canadian Corporation

CCT—Canadian Citizen
EDU—Educational Institution

GOV—Government

HOP—Hospital

INB—Indian Band

LAM—Library, Archive, or Museum

LGR—Legal Representative

MAJ—Her Majesty the Queen

OMK—Protected by Trademarks Act

PLT—Political Party

PRT—Partnership
RES—Permanent Resident

TDM—Trademark Owner

TRD—Trade Union

TRS—Trust
org_nameOptional for individualsThe name of the organization.
phoneOptionalMaximum 20 characters, in the format
+CCC.NNNNNNNNNNxEEEE, where C = country code,
N = phone number, and E = extension (optional).
postal_codeOptionalMaximum 16 characters.
stateOptionalA valid 2 letter code for the Canadian province:

AB—Alberta

BC—British Columbia

MB—Manitoba

NB—New Brunswick

NL—Newfoundland and Labrador

NT—Northwest Territories

NS—Nova Scotia

NU—Nunavut

ON—Ontario

PE—Prince Edward Island

QC—Quebec

SK—Saskatchewan

* YT—Yukon

For data = contact_info

When the data parameter uses the contact_info value, the following
additional parameters can be used.

📘

Note:

The contact_info value is not supported for .DK. Use the update_all_info ADD LINK command to change the contact information for .DK domains.

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
contact_setRequiredA hash containing the modified contact information of a specific type:

admin

billing

owner

Note: The owner contact for .IT domains requires three additional parameters: entity_type, nationality_code, and reg_code. For information about these parameters, see “.ITcontactrequirements”.

tech


For more information about contact_set values, see "ContactSet". ADD LINK
org_nameRequiredOrganization name.
report_emailOptionalThe End User's email address to which notification of success or failure is sent. The notification email is sent on behalf of the reseller.

Note: This parameter can only be specified if affect_domains is set to '1'

Contact_Set

You can submit different contact information for each contact type, or you
can use the also_apply_to parameter to apply the changes to other contact
types.

Parameters within the contact_set associative array are described below.

Parameter nameObligationDefinition/Value
also_apply_toOptionalAn array of other contact types to which you want to
apply the changes.

For example, if you want to apply the changes
indicated in the admin contact set to the owner and
tech types as well, use:

also_apply_to => ['owner', 'tech']

If only one contact type is specified and also_apply_to is empty, update only that contact type.

If also_apply_to is specified, but the complete contact set for the contact types in also_apply_to is also submitted, the complete contact set is used, and also_apply_to is ignored.

Allowed values are:

owner— Owner
contact information

admin— Administrator contact information

billing— Billing contact information

Note: This value is not supported for .IT
domains; if submitted, the command will fail.

tech— Tech
contact information

For data = domain_auth_info

When the data parameter uses the domain_auth_info value, the following
additional parameter can be used:

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
domain_auth_infoRequiredDomain authentication code. (For .COM,
.NET, .ORG, .INFO, .BIZ, .CA, .CN, .CO, .IN,
.ME, .MOBI, .NAME, and .US TLDs only.)

For data = expire_action

When the data parameter uses the expire_action value, the following
additional parameter can be used:

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
auto_renewRequiredDetermines whether the domain renews automatically.

0—Do not set to auto-renew.
1—Set to auto-renew.
let_expireRequiredDetermines whether to allow the domain to expire at the end of the registration term.

0—Do not expire domain silently. Reseller and registrant renewal reminders will be sent.

1—Expire domain silently. Expiry notifications will not be sent to the reseller, but any ICANN mandated notifications will continue to be sent to the registrant.

Note: This flag cannot be used for .DE domains. To delete a .DE name or allow it to
expire, you need to complete and submit the Domain Termination/Deletion form at
least 5 days prior to the expiry date:
http://opensrs.com/site/resources/agreements/domain-policies#de

For data = forwarding_email

When the data parameter uses the forwarding_email value, the following
additional parameter can be used:

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
forwarding_emailRequiredFor use with .NAME forwarding feature.

For data = it_whois_display_setting

When the data parameter uses the it_whois_display_setting value, the
following additional parameter can be used:

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
consent_for_publishingRequiredThe setting for the .IT Whois Privacy.

Allowed values are:
N—When a WHOIS lookup is done on the domain name, do not display personal information. Privacy ON.

Y—When a WHOIS lookup is done on the domain name, display all of the data that is on the WHOIS
directory, including name, address, telephone
number and email address. Privacy OFF.

For data = parkpage_state

This parameter is used to enable or disable the Parked Pages service for a
particular domain. The Parked Pages service is available for .COM, .NET,
.ORG, .INFO, .BIZ, .MOBI, .NAME, .ASIA, .BE, .BZ, .CA, .CC, .CO, .EU,
.IN, .ME, .NL, .TV, .UK, .US, .WS and .XXX domains.

When the data parameter uses the parkpage_state value, the following
additional parameter can be used:

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
domainRequiredThe domain for which you want to enable or disable Parked Pages.
stateRequiredUsed to enable or disable the Parked Pages service
for a domain.

on—Enable Parked Pages
off—Disable Parked Pages

For data = rsp_whois_info

When the data parameter uses the rsp_whois_info value, the following
additional parameter can be used:

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
allRequiredIndicates whether the request is to be applied to all domains in the profile.

0—Do not apply to all domains; this is the
default.

1—Apply the request to all domains in the
profile.
affect_domainsRequiredFlag indicating the domains to which the change is to be applied.

0—Only change this specific domain.

1—Change applies to all domains linked to
this profile.
flagRequiredSpecifies whether to display the RSP info in Whois query results.

Y—Display RSP info.
N—Do not display RSP info.

For data = status

When the data parameter uses the status value, the following additional
parameter can be used:

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
domainRequiredThe relevant domain.
lock_stateRequiredIndicates whether to lock the domain.

0—Unlocked
1—Locked

For data = whois_privacy_state

When the data parameter uses the whois_privacy_state value, the following
additional parameters can be used:

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationvDefinition/Value
affect_domainsRequiredDetermines whether to apply the change to all domains in the reseller's profile, on just the specified domain.

0—Apply change to this domain only.

1—Apply to all domains linked to this profile.
report_emailOptionalThe End User's email address to which notification of success or failure is sent on behalf of the reseller.

Note: This parameter can only be specified if affect_domains is set to 1.
stateRequiredUsed to enable or disable WHOIS Privacy. Allowed
values are enable or disable.

Note: The following values are deprecated, but are still accepted for backward compatibility:

N—Disable WHOIS Privacy

Y—Enable WHOIS Privacy

Response parameters for modify (domain)

Standard parameters

  • action = reply
  • object = domain
  • is_success = a Boolean is returned, indicating success or failure of the
    request
  • response_code = response code indicating outcome of the request
  • response_text = message describing the outcome of the request

Attributes

If the request is successful, the attributes associative array may include the
following:

Parameter nameObligationDefinition/Value
detailsReturned if is_success = trueA case-by-case description of the success or failure of each affected domain.

The key is the name of the domain.

When you specify a contact_info modification, you can specify that you want
the action to apply to all domains.

Because the modification may succeed or fail on a case-by-case basis, you get a response code for each domain that is
affected.

The key that is used to access this domain success information is the name of the
domain itself, for example, 'mydomain.com' or 'mydomain.co.uk'.

Each key contains a hash (described below) that provides details on the action performed on that domain.
encoding_typeOptionalThe encoding type for this domain. For a list
of languages and codes, see “AppendixC: Encoding Types for IDN”.
response_codeReturned if is_success = trueThe response code associated with the modification on this domain.
response_textReturned if is_success = trueThe response text associated with the modification on this domain.
waiting_requests_noReturned if is_success = trueThe number of registry requests in the waiting state.

Modify (domain) Examples

For data = ca_whois_display_setting

Request

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">MODIFY</item>
                <item key="object">DOMAIN</item>
                <item key="domain”>example.ca</item>
                <item key="registrant_ip">10.0.62.142</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="data">ca_whois_display_setting</item>
                        <item key="display">FULL</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">OK</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For data = change_ips_tag

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">MODIFY</item>
                <item key="object">DOMAIN</item>
                <item key="registrant_ip">10.0.11.121</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="affect_domains">0</item>
                        <item key="data">change_ips_tag</item>
                        <item key="domain">example.me.uk</item>
                        <item key="gaining_registrar_tag">q1q1</item>
                        <item key="change_tag_all">0</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Command successfully
                    completed.</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
 <header>
  <version>0.9</version>
  </header>
 <body>
  <data_block>
   <dt_assoc>
    <item key="protocol">XCP</item>
    <item key="object">DOMAIN</item>
    <item key="response_text">q1q1 Tag not found on the Nominet&apos;s list of valid tags. Please contact the new Tag Holder to confirm.</item>
    <item key="action">REPLY</item>
    <item key="response_code">400</item>
    <item key="is_success">0</item>
   </dt_assoc>
  </data_block>
 </body>
</OPS_envelope>

For data = cira_registrant

Request

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">MODIFY</item>
                <item key="object">DOMAIN</item>
                <item key="domain”>example.ca</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="data">cira_registrant</item>
                        <item key="first_name">Pierre</item>
                        <item key="last_name">Lalonde</item>
                        <item key="org_name">Example Inc.</item>
                        <item key="address1">32 Oak St.</item>
                        <item key="address2">Suite 100</item>
                        <item key="address3" />
                        <item key="city">Toronto</item>
                        <item key="state">ON</item>
                        <item key="postal_code">M1M 1M1</item>
                        <item key="country">CA</item>
                        <item key="legal_type">CCT</item>
                        <item key="email">[email protected]</item>
                        <item key="phone">+1.4165551212x1234</item>
                        <item key="fax">+1.4165551024</item>
                        <item key="lang">FR</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">OK</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For data = contact_info

Example 1

In this example, only one type is specified and also_apply_to contains other types.

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">MODIFY</item>
                <item key="object">DOMAIN</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="registrant_ip">111.121.121.11</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="data">contact_info</item>
                        <item key="affect_domains">0</item>
                        <item key="contact_set">
                            <dt_assoc>
                                <item key="also_apply_to">
                                    <dt_array>
                                        <item key="0">owner</item>
                                        <item key="1">billing</item>
                                    </dt_array>
                                </item>
                                <item key="admin">
                                    <dt_assoc>
                                        <item key="first_name">Adler</item>
                                        <item key="last_name">Adams</item>
                                        <item key="org_name">Example Inc.</item>
                                        <item key="address1">32 Oak St.</item>
                                        <item key="address2">Suite 100</item>
                                        <item key="address3" />
                                        <item key="city">Santa Clara</item>
                                        <item key="state">CA</item>
                                        <item key="postal_code">90210</item>
                                        <item key="country">US</item>
                                        <item key="phone">+1.7075551212x1812</item>
                                        <item key="fax">+1.7075553123</item>
                                        <item key="email">[email protected]</item>
                                        <item key="url">http://www.example.com</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Modification(s) successful</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="details">
                            <dt_assoc>
                                <item key="example.com">
                                    <dt_assoc>
                                        <item key="response_text">Contact
                                            modification successful</item>
                                        <item key="response_code">200</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 2

In this example, admin and tech contact information is changed for a .CA
domain.

📘

Note:

For .CA domains when data = contact_info, instead of address1,
address2, and address3, you can specify these address attributes:
addr_office, addr_address_number, addr_street_name, addr_street_cat,
and addr_orientation.

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">

<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">MODIFY</item>
                <item key="object">DOMAIN</item>
                <item key="domain”>example.ca</item>
                <item key="registrant_ip">72.53.78.221</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="affect_domains">0</item>
                        <item key="contact_set">
                            <dt_assoc>
                                <item key="admin">
                                    <dt_assoc>
                                        <item key="org_name">Example Co.</item>
                                        <item key="first_name">Adler</item>
                                        <item key="last_name">Adams</item>
                                        <item key="ddress1">32 Oak Street</item>
                                        <item key="address2">Suite 100</item>
                                        <item key="address3" />
                                        <item key="city">Saskatoon</item>
                                        <item key="state">SK</item>
                                        <item key="country">CA</item>
                                        <item key="postal_code">M1M1M1</item>
                                        <item key="phone">+1/4165551212</item>
                                        <item key="fax">+1.4165552222</item>
                                        <item key="email">[email protected]</item>
                                        <item key="language">EN</item>
                                    </dt_assoc>
                                </item>
                                <item key="also_apply_to">
                                    <dt_array>
                                        <item key="0">tech</item>
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="report_email"></item>
                        <item key="data">contact_info</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Modification(s) successful</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="details">
                            <dt_assoc>
                                <item key="example.ca">
                                    <dt_assoc>
                                        <item key="response_text">Contact
                                            modification successful</item>
                                        <item key="response_code">200</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 3

In this example, owner contact information is modified for a .IT domain.
The .IT owner contact requires three additional parameters:
nationality_code, reg_code, and entity_type.

📘

Note:

The other contact types do not require these additional parameters, so
if you change the owner contact information, and you use also_apply_to to
apply the changes to another type, for example, tech, the command will be
successful, but those additional parameters and values are ignored by the
other contact type. However, also_apply_to billing is not supported for .IT
domains, and if you submit that value, the command will fail. When the
domain owner is a person (entity_type = 1), changing the owner contact
information also changes the admin contact information as these are
considered to be the same at the Registry.

Request

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">MODIFY</item>
                <item key="object">DOMAIN</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="registrant_ip">10.0.62.128</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="affect_domains"></item>
                        <item key="report_email"></item>
                        <item key="data">contact_info</item>
                        <item key="contact_set">
                            <dt_assoc>
                                <item key="owner">
                                    <dt_assoc>
                                        <item key="entity_type">1</item>
                                        <item key="nationality_code">IT</item>
                                        <item key="first_name">Mario</item>
                                        <item key="last_name">Segale</item>
                                        <item key="org_name"></item>
                                        <item key="address1">Via del Campidoglio, 1</item>
                                        <item key="address2"></item>
                                        <item key="address3"></item>
                                        <item key="city">Rome</item>
                                        <item key="state">RM</item>
                                        <item key="country">IT</item>
                                        <item key="postal_code">00123</item>
                                        <item key="email">[email protected]</item>
                                        <item key="reg_code">SGLMRA80A01H501E</item>
                                        <item key="phone">+39.0612345678</item>
                                        <item key="fax"></item>
                                    </dt_assoc>
                                </item>
                                <item key="also_apply_to" />
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">Command completed successfully</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="details">
                            <dt_assoc>
                                <item key="example033.it">
                                    <dt_assoc>
                                        <item key="response_text">Command completed successfully</item>
                                        <item key="waiting_requests_no">0</item>
                                        <item key="encoding_type"></item>
                                        <item key="response_code">200</item>
                                        <item key="is_success">1</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For data = domain_auth_info

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain">acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="affect_domains">0</item>
                        <item key="domain_auth_info">mysecret</item>
                        <item key="data">domain_auth_info</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Domain auth code modification
                    Successful</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For data = expire_action

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain">acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="affect_domains">0</item>
                        <item key="auto_renew">0</item>
                        <item key="let_expire">0</item>
                        <item key="data">expire_action</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">Update successful</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For data = forwarding_email

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="affect_domains">0</item>
                        <item key="forwarding_email">[email protected]</item>
                        <item key="data">forwarding_email</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Domain forwarding email
                    modification Successful</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For data = it_whois_display_setting

Request

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="object">DOMAIN</item>
                <item key="action">MODIFY</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">ariacorporate.it</item>
                        <item key="consent_for_publishing">N</item>
                        <item key="data">it_whois_display_setting</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">OK</item>
                <item key="action">REPLY</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For data = parkpage_state

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">MODIFY</item>
                <item key="object">DOMAIN</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="affect_domains">0</item>
                        <item key="state">on</item>
                        <item key="data">parkpage_state</item>
                        <item key="domain">example.com</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Parked page successfully enabled
                    for domain example.com</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For data = rsp_whois_info

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="affect_domains">0</item>
                        <item key="flag">Y</item>
                        <item key="all">1</item>
                        <item key="data">rsp_whois_info</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Command Successfully
                    Completed</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For data = status

Note that the conditions for this succeeding are those for which a get
domain status call would return a can_modify result of true (1).

Example 1

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="affect_domains">0</item>
                        <item key="lock_state">0</item>
                        <item key="data">status</item>
                        <item key="domain">example.com</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Lock disabled for
                    example.com</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 2

Without end-user credentials

Request

<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">example.com</item>
                        <item key="lock_state">0</item>
                        <item key="data">status</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">Lock disabled for example.com</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For data = whois_privacy_state

Example 1

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="affect_domains">0</item>
                        <item key="report_email" />
                        <item key="state">disable</item>
                        <item key="data">whois_privacy_state</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Whois Privacy successfully
                    disabled</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 2

Without end-user credentials

Request

<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">example.com</item>
                        <item key="state">enable</item>
                        <item key="data">whois_privacy_state</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">Whois Privacy successfully disabled</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For data = whois_publicity_state

Example 1

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="affect_domains">0</item>
                        <item key="report_email" />
                        <item key="state">disable</item>
                        <item key="data">whois_publicity_state</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Whois Publicity successfully
                    disabled</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 2

Without end-user credentials

Request

<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">example.com</item>
                        <item key="state">enable</item>
                        <item key="data">whois_publicity_state</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">Whois Publicity successfully enabled</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For tld_data = ced_info (.ASIA)

Example 1

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="affect_domains">0</item>
                        <item key="data">tld_data</item>
                        <item key="tld_data">
                            <dt_assoc>
                                <item key="ced_info">
                                    <dt_assoc>
                                        <item key="contact_type">tech</item>
                                        <item key="legal_entity_type">other</item>
                                        <item key="legal_entity_type_info">add some text here</item>
                                        <item key="id_type">other</item>
                                        <item key="id_type_info">other</item>
                                        <item key="id_number">8675309</item>
                                        <item key="locality_city">Sydney</item>
                                        <item key="locality_state_prov">NSW</item>
                                        <item key="locality_country">AU</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">Data modification Successful</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 2

Without end-user credentials

Request

<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">example.asia</item>
                        <item key="data">tld_data</item>
                        <item key="tld_data">
                            <dt_assoc>
                                <item key="ced_info">
                                    <dt_assoc>
                                        <item key="contact_type">tech</item>
                                        <item key="id_number">8675309</item>
                                        <item key="id_type">passport</item>
                                        <item key="legal_entity_type">corporation</item>
                                        <item key="locality_city">Sydney</item>
                                        <item key="locality_state_prov">NSW</item>
                                        <item key="locality_country">AU</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">CED Data modification Successful</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
</header>

For tld_data = ipr_data (.XXX)

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>

<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>

<OPS_envelope>
    
    <header>
        
        <version>0.9</version>
        
    </header>
    
    <body>
        
        <data_block>
            
            <dt_assoc>
                
                <item key="protocol">XCP</item>
                
                <item key="action">modify</item>
                
                <item key="object">domain</item>
                
                <item key="cookie">364577922:3202133</item>
                
                <item key="attributes">
                    
                    <dt_assoc>
                        
                        <item key='data'>tld_data</item>
                        
                        <item key='tld_data'>
                            
                            <dt_assoc>
                                
                                <item key='ipr_data'>
                                    
                                    <dt_assoc>
                                        
                                        <item key="icm_membership_id">123456</item>
                                        
                                    </dt_assoc>
                                    
                                </item>
                                
                            </dt_assoc>
                            
                        </item>
                        
                    </dt_assoc>
                </item>
                
            </dt_assoc>
            
        </data_block>
        
    </body>
    
</OPS_envelope>

    <header>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>

<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>

<OPS_envelope>
    
    <header>
        
        <version>0.9</version>
        
    </header>
    
    <body>
        
        <data_block>
            
            <dt_assoc>
                
                <item key="protocol">XCP</item>
                
                <item key="action">REPLY</item>
                
                <item key="object">DOMAIN</item>
                
                <item key="response_text">OK</item>
                
                <item key="is_success">1</item>
                
                <item key="response_code">200</item>
                
            </dt_assoc>
            
        </data_block>
        
    </body>
    
</OPS_envelope>

For tld_data = it_registrant_info (.IT)

Request

<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="data">tld_data</item>
                        <item key="tld_data">
                            <dt_assoc>
                                <item key="it_registrant_info">
                                    <dt_assoc>
                                        <item key="entity_type">1</item>
                                        <item key="reg_code">SGLMRA80A01H501E</item>
                                        <item key="nationality_code">it</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_text">Command completed successfully</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="details">
                            <dt_assoc>
                                <item key="feb22test1.it">
                                    <dt_assoc>
                                        <item key="response_text">Command completed successfully</item>
                                        <item key="waiting_requests_no">0</item>
                                        <item key="encoding_type"></item>
                                        <item key="response_code">200</item>
                                        <item key="is_success">1</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For tld_data = nexus (.US)

Example 1

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="affect_domains">0</item>
                        <item key="data">tld_data</item>
                        <item key="tld_data">
                            <dt_assoc>
                                <item key="nexus">
                                    <dt_assoc>
                                        <item key="validator">CA</item>
                                        <item key="category">C31</item>
                                        <item key="app_purpose">P1</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">Nexus Data modification Successful</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For tld_data =professional_data (.PRO)

Request

<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="data">tld_data</item>
                        <item key="tld_data">
                            <dt_assoc>
                                <item key="professional_data">
                                    <dt_assoc>
                                        <item key="authority_website">http://www.cda-adc.ca</item>
                                        <item key="license_number">987654321</item>
                                        <item key="authority">Canadian Dental Association</item>
                                        <item key="profession">Dentist</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>

<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>

<OPS_envelope>
    
    <header>
        
        <version>0.9</version>
        
    </header>
    
    <body>
        
        <data_block>
            
            <dt_assoc>
                
                <item key='protocol'>XCP</item>
                
                <item key='action'>REPLY</item>
                
                <item key='object'>DOMAIN</item>
                
                <item key='response_text'>OK</item>
                
                <item key='response_code'>200</item>
                
                <item key='is_success'>1</item>
            </dt_assoc>
            
        </data_block>
        
    </body>
    
</OPS_envelope

For tld_data = registrant_extra_info (.COOP)

Request

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="data">tld_data</item>
                        <item key="tld_data">
                            <dt_assoc>
                                <item key="professional_data">
                                    <dt_assoc>
                                        <item key="authority_website">http://www.cda-adc.ca</item>
                                        <item key="license_number">987654321</item>
                                        <item key="authority">Canadian Dental Association</item>
                                        <item key="profession">Dentist</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">OK</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For tld_data = registrant_extra_info (.JOBS)

Request

<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="data">tld_data</item>
                        <item key="tld_data">
                            <dt_assoc>
                                <item key="registrant_extra_info">
                                    <dt_assoc>
                                        <item key="jobs_admin_type">Yes</item>
                                        <item key="jobs_website">http://www.example.com</item>
                                        <item key="jobs_association_member">Yes</item>
                                        <item key="jobs_title">HR Generalist</item>
                                        <item key="jobs_industry_type">Logistics Management</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="data">tld_data</item>
                        <item key="tld_data">
                            <dt_assoc>
                                <item key="registrant_extra_info">
                                    <dt_assoc>
                                        <item key="jobs_admin_type">Yes</item>
                                        <item key="jobs_website">http://www.example.com</item>
                                        <item key="jobs_association_member">Yes</item>
                                        <item key="jobs_title">HR Generalist</item>
                                        <item key="jobs_industry_type">Logistics
Management</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

For tld_data = registrant_extra_info (.RU)

Request

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">modify</item>
                <item key="object">domain</item>
                <item key="domain”>acmeinc.biz</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="data">tld_data</item>
                        <item key="tld_data">
                            <dt_assoc>
                                <item key="registrant_extra_info">
                                    <dt_assoc>
                                        <item key="date_of_birth">1976-08-05</item>
                                        <item key="id_card_authority">Republic of Khakassia </item>
                                        <item key="id_card_issue_date">2001-01-01</item>
                                        <item key="id_card_number">987654321</item>
                                        <item key="registrant_type">individual</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">OK</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Updated 8 months ago

modify (domain)


Changes information associated with a domain, such as contact info. The
action request message is different depending on the type of modification
being made, and is shown separately for each type.

This command also allows you to set an auto-renew flag for the domain from
which you logged in. If you are using the affected_domains option, you can
set the renewal action flags for all domains in the user's profile.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.