Manage Domain Settings

Retrieve a list of Domains for the specified Shopper

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Query Parameters

statuses?array<>

Only include results with status value in the specified set

statusGroups?array<>

Only include results with status value in any of the specified groups

limit?integer

Maximum number of domains to return

Range1 <= value <= 1000

marker?string

Marker Domain to use as the offset in results

includes?array<>

Optional details to be included in the response

modifiedDate?string

Only include results that have been modified since the specified date

Formatiso-datetime

Header Parameters

X-Shopper-Id?string

Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.

Response Body

curl -X GET "https://example.com/v1/domains"

[  {    "authCode": "string",    "contactAdmin": {      "addressMailing": {        "address1": "string",        "address2": "string",        "city": "string",        "country": "AC",        "postalCode": "string",        "state": "string"      },      "email": "user@example.com",      "fax": "string",      "jobTitle": "string",      "nameFirst": "string",      "nameLast": "string",      "nameMiddle": "string",      "organization": "string",      "phone": "string"    },    "contactBilling": {      "addressMailing": {        "address1": "string",        "address2": "string",        "city": "string",        "country": "AC",        "postalCode": "string",        "state": "string"      },      "email": "user@example.com",      "fax": "string",      "jobTitle": "string",      "nameFirst": "string",      "nameLast": "string",      "nameMiddle": "string",      "organization": "string",      "phone": "string"    },    "contactRegistrant": {      "addressMailing": {        "address1": "string",        "address2": "string",        "city": "string",        "country": "AC",        "postalCode": "string",        "state": "string"      },      "email": "user@example.com",      "fax": "string",      "jobTitle": "string",      "nameFirst": "string",      "nameLast": "string",      "nameMiddle": "string",      "organization": "string",      "phone": "string"    },    "contactTech": {      "addressMailing": {        "address1": "string",        "address2": "string",        "city": "string",        "country": "AC",        "postalCode": "string",        "state": "string"      },      "email": "user@example.com",      "fax": "string",      "jobTitle": "string",      "nameFirst": "string",      "nameLast": "string",      "nameMiddle": "string",      "organization": "string",      "phone": "string"    },    "createdAt": "2019-08-24T14:15:22Z",    "deletedAt": "2019-08-24T14:15:22Z",    "transferAwayEligibleAt": "2019-08-24T14:15:22Z",    "domain": "string",    "domainId": 0.1,    "expirationProtected": true,    "expires": "2019-08-24T14:15:22Z",    "exposeWhois": true,    "holdRegistrar": true,    "locked": true,    "nameServers": [      "string"    ],    "privacy": true,    "registrarCreatedAt": "string",    "renewAuto": true,    "renewDeadline": "2019-08-24T14:15:22Z",    "renewable": true,    "status": "string",    "transferProtected": true  }]

Validate the request body using the Domain Contact Validation Schema for specified domains.

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Query Parameters

marketId?string

MarketId in which the request is being made, and for which responses should be localized

Formatbcp-47

Default"en-US"

Request Body

An instance document expected for domains contacts validation

contactAdmin?

contactBilling?

contactPresence?

contactRegistrant?

contactTech?

domains*array<>

An array of domain names to be validated against. Alternatively, you can specify the extracted tlds. However, full domain names are required if the tld is uk

entityType?string

Canadian Presence Requirement (CA)

Value in

"ABORIGINAL"
"ASSOCIATION"
"CITIZEN"
"CORPORATION"
"EDUCATIONAL"
"GOVERNMENT"
"HOSPITAL"
"INDIAN_BAND"
"LEGAL_REPRESENTATIVE"
"LIBRARY_ARCHIVE_MUSEUM"
"MARK_REGISTERED"
"MARK_TRADE"
"PARTNERSHIP"
"POLITICAL_PARTY"
"RESIDENT_PERMANENT"
"TRUST"
"UNION"

Response Body

curl -X POST "https://example.com/v1/domains/contacts/validate" \  -H "Content-Type: application/json" \  -d '{    "domains": [      "string"    ]  }'

Empty

Retrieve details for the specified Domain

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

domain*string

Domain name whose details are to be retrieved

Header Parameters

X-Shopper-Id?string

Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.

Response Body

curl -X GET "https://example.com/v1/domains/string"

{  "authCode": "string",  "contactAdmin": {    "addressMailing": {      "address1": "string",      "address2": "string",      "city": "string",      "country": "AC",      "postalCode": "string",      "state": "string"    },    "email": "user@example.com",    "fax": "string",    "jobTitle": "string",    "nameFirst": "string",    "nameLast": "string",    "nameMiddle": "string",    "organization": "string",    "phone": "string"  },  "contactBilling": {    "addressMailing": {      "address1": "string",      "address2": "string",      "city": "string",      "country": "AC",      "postalCode": "string",      "state": "string"    },    "email": "user@example.com",    "fax": "string",    "jobTitle": "string",    "nameFirst": "string",    "nameLast": "string",    "nameMiddle": "string",    "organization": "string",    "phone": "string"  },  "contactRegistrant": {    "addressMailing": {      "address1": "string",      "address2": "string",      "city": "string",      "country": "AC",      "postalCode": "string",      "state": "string"    },    "email": "user@example.com",    "fax": "string",    "jobTitle": "string",    "nameFirst": "string",    "nameLast": "string",    "nameMiddle": "string",    "organization": "string",    "phone": "string"  },  "contactTech": {    "addressMailing": {      "address1": "string",      "address2": "string",      "city": "string",      "country": "AC",      "postalCode": "string",      "state": "string"    },    "email": "user@example.com",    "fax": "string",    "jobTitle": "string",    "nameFirst": "string",    "nameLast": "string",    "nameMiddle": "string",    "organization": "string",    "phone": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "deletedAt": "2019-08-24T14:15:22Z",  "transferAwayEligibleAt": "2019-08-24T14:15:22Z",  "domain": "string",  "domainId": 0.1,  "expirationProtected": true,  "expires": "2019-08-24T14:15:22Z",  "exposeRegistrantOrganization": true,  "exposeWhois": true,  "holdRegistrar": true,  "locked": true,  "nameServers": [    "string"  ],  "privacy": true,  "registrarCreatedAt": "string",  "renewAuto": true,  "renewDeadline": "2019-08-24T14:15:22Z",  "status": "string",  "subaccountId": "string",  "transferProtected": true,  "verifications": {    "domainName": {      "status": "APPROVED"    },    "realName": {      "status": "APPROVED"    }  }}

Update details for the specified Domain

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

domain*string

Domain whose details are to be updated

Header Parameters

X-Shopper-Id?string

Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.

Request Body

Changes to apply to existing Domain

locked?boolean

Whether or not the domain should be locked to prevent transfers

nameServers?array<>

Fully-qualified domain names for Name Servers to associate with the domain

renewAuto?boolean

Whether or not the domain should be configured to automatically renew

subaccountId?string

Reseller subaccount shopperid who can manage the domain

exposeRegistrantOrganization?boolean

Whether or not the domain registrant contact organization field should be shown in the WHOIS

exposeWhois?boolean

Whether or not the domain contact details should be shown in the WHOIS

consent?

Response Body

curl -X PATCH "https://example.com/v1/domains/string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Cancel a purchased domain

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

domain*string

Domain to cancel

Response Body

curl -X DELETE "https://example.com/v1/domains/string"

Empty

Update domain

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

domain*string

Domain whose Contacts are to be updated.

Header Parameters

X-Shopper-Id?string

Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.

Request Body

Changes to apply to existing Contacts

contactAdmin?

contactBilling?

contactRegistrant*

contactTech?

Response Body

curl -X PATCH "https://example.com/v1/domains/string/contacts" \  -H "Content-Type: application/json" \  -d '{    "contactRegistrant": {      "addressMailing": {        "address1": "string",        "city": "string",        "country": "AC",        "postalCode": "string",        "state": "string"      },      "email": "user@example.com",      "nameFirst": "string",      "nameLast": "string",      "phone": "string"    }  }'

Empty

Re-send Contact E-mail Verification for specified Domain

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

curl -X POST "https://example.com/v1/domains/string/verifyRegistrantEmail"

Empty

Agent & Automation Notes

Scopes

domains.domain:read, domains.domain:create, domains.domain:delete, domains.domain:update, domains.contact:update, domains.dns:update, domains.transfer:execute

Rate limit60 req/min per credential

On failureGET operations are safe to retry. PUT/PATCH DNS are idempotent by shape. POST purchase is NOT idempotent — verify state before retrying.

Guides

Concepts

Last updated on

Manage Domain Settings

200application/json

400application/json

401application/json

403application/json

422application/json

429application/json

500application/json

200

204

400application/json

422application/json

429application/json

500application/json

200application/json

203application/json

400application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

200

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200

400application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

200

204

400application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

504application/json

200

400application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

504application/json