# Manage Domain Settings (https://developer.godaddy.com/en/docs/references/rest/domains/v1/manage-domain-settings) *** title: Manage Domain Settings full: true \_openapi: toc: * depth: 2 title: Retrieve a list of Domains for the specified Shopper url: '#retrieve-a-list-of-domains-for-the-specified-shopper' * depth: 2 title: >- Validate the request body using the Domain Contact Validation Schema for specified domains. url: >- \#validate-the-request-body-using-the-domain-contact-validation-schema-for-specified-domains * depth: 2 title: Retrieve details for the specified Domain url: '#retrieve-details-for-the-specified-domain' * depth: 2 title: Update details for the specified Domain url: '#update-details-for-the-specified-domain' * depth: 2 title: Cancel a purchased domain url: '#cancel-a-purchased-domain' * depth: 2 title: Update domain url: '#update-domain' * depth: 2 title: Re-send Contact E-mail Verification for specified Domain url: '#re-send-contact-e-mail-verification-for-specified-domain' structuredData: headings: * content: Retrieve a list of Domains for the specified Shopper id: retrieve-a-list-of-domains-for-the-specified-shopper * content: >- Validate the request body using the Domain Contact Validation Schema for specified domains. id: >- validate-the-request-body-using-the-domain-contact-validation-schema-for-specified-domains * content: Retrieve details for the specified Domain id: retrieve-details-for-the-specified-domain * content: Update details for the specified Domain id: update-details-for-the-specified-domain * content: Cancel a purchased domain id: cancel-a-purchased-domain * content: Update domain id: update-domain * content: Re-send Contact E-mail Verification for specified Domain id: re-send-contact-e-mail-verification-for-specified-domain contents: * content: >- Returns a paginated list of domains owned by the authenticated account. Supports filtering by status and optional inclusion of contacts, nameservers, and authCode in each record. heading: retrieve-a-list-of-domains-for-the-specified-shopper * content: >- All contacts specified in request will be validated against all domains specified in "domains". As an alternative, you can also pass in tlds, with the exception of `uk`, which requires full domain names heading: >- validate-the-request-body-using-the-domain-contact-validation-schema-for-specified-domains * content: >- Returns the full DomainDetail object including status, contacts, nameservers, lock state, privacy flag, and expiration timestamp. heading: retrieve-details-for-the-specified-domain * content: >- Updates one or more fields on the domain. Accepts a partial DomainUpdate body - only fields included are modified. Returns 204 No Content. heading: update-details-for-the-specified-domain * content: >- Cancels a purchased domain and initiates a refund if within the cancellation window. This action is irreversible. heading: cancel-a-purchased-domain * content: >- Updates domain settings. Only fields included in the request body are modified. Returns 204 No Content. heading: update-domain * content: >- Re-sends the ICANN registrant email verification to the domain's registrant contact. Use when the original verification email was not received or has expired. heading: re-send-contact-e-mail-verification-for-specified-domain *** ## GET /v1/domains Retrieve a list of Domains for the specified Shopper Returns a paginated list of domains owned by the authenticated account. Supports filtering by status and optional inclusion of contacts, nameservers, and authCode in each record. ### Query parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `statuses` | array | no | Only include results with `status` value in the specified set | | `statusGroups` | array | no | Only include results with `status` value in any of the specified groups | | `limit` | integer | no | Maximum number of domains to return | | `marker` | string | no | Marker Domain to use as the offset in results | | `includes` | array | no | Optional details to be included in the response | | `modifiedDate` | string | no | Only include results that have been modified since the specified date | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Shopper-Id` | string | no | 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. | ### Responses **200** — Request was successful Content-Type: `application/json` Schema: - array - items: - `authCode`: string — Authorization code for transferring the Domain - `contactAdmin`: object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `exposeWhois`: boolean — Whether or not the domain contact details should be shown in the WHOIS - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers`: array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `renewable`: boolean — Whether or not the domain is eligble for renewal based on status - `status` (required): string — Processing status of the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer Content-Type: `application/javascript` Schema: - array - items: - `authCode`: string — Authorization code for transferring the Domain - `contactAdmin`: object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `exposeWhois`: boolean — Whether or not the domain contact details should be shown in the WHOIS - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers`: array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `renewable`: boolean — Whether or not the domain is eligble for renewal based on status - `status` (required): string — Processing status of the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer Content-Type: `application/xml` Schema: - array - items: - `authCode`: string — Authorization code for transferring the Domain - `contactAdmin`: object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `exposeWhois`: boolean — Whether or not the domain contact details should be shown in the WHOIS - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers`: array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `renewable`: boolean — Whether or not the domain is eligble for renewal based on status - `status` (required): string — Processing status of the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer Content-Type: `text/javascript` Schema: - array - items: - `authCode`: string — Authorization code for transferring the Domain - `contactAdmin`: object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `exposeWhois`: boolean — Whether or not the domain contact details should be shown in the WHOIS - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers`: array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `renewable`: boolean — Whether or not the domain is eligble for renewal based on status - `status` (required): string — Processing status of the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer Content-Type: `text/xml` Schema: - array - items: - `authCode`: string — Authorization code for transferring the Domain - `contactAdmin`: object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `exposeWhois`: boolean — Whether or not the domain contact details should be shown in the WHOIS - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers`: array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `renewable`: boolean — Whether or not the domain is eligble for renewal based on status - `status` (required): string — Processing status of the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer **400** — Request was malformed Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **401** — Authentication info not sent or invalid Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **403** — Authenticated user is not allowed access Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **422** — Limit must have a value no greater than 1000 Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **429** — Too many requests received within interval Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request **500** — Internal server error Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **Security:** requires `bearerAuth`. ## POST /v1/domains/contacts/validate Validate the request body using the Domain Contact Validation Schema for specified domains. All contacts specified in request will be validated against all domains specified in "domains". As an alternative, you can also pass in tlds, with the exception of `uk`, which requires full domain names ### Query parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `marketId` | string | no | MarketId in which the request is being made, and for which responses should be localized | ### Request body (required) An instance document expected for domains contacts validation Content-Type: `application/json` Schema: - object - `contactAdmin`: object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactPresence`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `domains` (required): 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` - items: - `entityType`: string — Canadian Presence Requirement (CA) - enum: "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" Content-Type: `application/xml` Schema: - object - `contactAdmin`: object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactPresence`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `domains` (required): 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` - items: - `entityType`: string — Canadian Presence Requirement (CA) - enum: "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" Content-Type: `text/xml` Schema: - object - `contactAdmin`: object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactPresence`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `domains` (required): 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` - items: - `entityType`: string — Canadian Presence Requirement (CA) - enum: "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" ### Responses **200** — No response was specified **204** — Request was successful **400** — Request was malformed Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **422** — Request body doesn't fulfill schema, see details in `fields` Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `domains` (required): array — An array of domain names the error is for. If tlds are specified in the request, `domains` will contain tlds. For example, if `domains` in request is ["test1.com", "test2.uk", "net"], and the field is invalid for com and net, then one of the `fields` in response will have ["test1.com", "net"] as `domains` - items: - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — 1) JSONPath referring to the field within the data containing an error - `pathRelated`: string — JSONPath referring to the field on the object referenced by `path` containing an error - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `domains` (required): array — An array of domain names the error is for. If tlds are specified in the request, `domains` will contain tlds. For example, if `domains` in request is ["test1.com", "test2.uk", "net"], and the field is invalid for com and net, then one of the `fields` in response will have ["test1.com", "net"] as `domains` - items: - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — 1) JSONPath referring to the field within the data containing an error - `pathRelated`: string — JSONPath referring to the field on the object referenced by `path` containing an error - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `domains` (required): array — An array of domain names the error is for. If tlds are specified in the request, `domains` will contain tlds. For example, if `domains` in request is ["test1.com", "test2.uk", "net"], and the field is invalid for com and net, then one of the `fields` in response will have ["test1.com", "net"] as `domains` - items: - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — 1) JSONPath referring to the field within the data containing an error - `pathRelated`: string — JSONPath referring to the field on the object referenced by `path` containing an error - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `domains` (required): array — An array of domain names the error is for. If tlds are specified in the request, `domains` will contain tlds. For example, if `domains` in request is ["test1.com", "test2.uk", "net"], and the field is invalid for com and net, then one of the `fields` in response will have ["test1.com", "net"] as `domains` - items: - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — 1) JSONPath referring to the field within the data containing an error - `pathRelated`: string — JSONPath referring to the field on the object referenced by `path` containing an error - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `domains` (required): array — An array of domain names the error is for. If tlds are specified in the request, `domains` will contain tlds. For example, if `domains` in request is ["test1.com", "test2.uk", "net"], and the field is invalid for com and net, then one of the `fields` in response will have ["test1.com", "net"] as `domains` - items: - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — 1) JSONPath referring to the field within the data containing an error - `pathRelated`: string — JSONPath referring to the field on the object referenced by `path` containing an error - `message`: string — Human-readable, English description of the error **429** — Too many requests received within interval Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request **500** — Internal server error Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **Security:** requires `bearerAuth`. ## GET /v1/domains/{domain} Retrieve details for the specified Domain Returns the full DomainDetail object including status, contacts, nameservers, lock state, privacy flag, and expiration timestamp. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `domain` | string | yes | Domain name whose details are to be retrieved | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Shopper-Id` | string | no | 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. | ### Responses **200** — Request was successful Content-Type: `application/json` Schema: - object - `authCode` (required): string — Authorization code for transferring the Domain - `contactAdmin` (required): object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `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 - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers` (required): array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `status` (required): string — Processing status of the domain - `subaccountId`: string — Reseller subaccount shopperid who can manage the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer - `verifications`: object - `domainName`: object - `status` (required): string — Status of the domain name verification - enum: "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" - `realName`: object - `status` (required): string — Status of the real name verification: - enum: "APPROVED", "PENDING", "REJECTED_DOCUMENT_OUTDATED", "REJECTED_EXPIRED_BUSINESS_LICENSE", "REJECTED_EXPIRED_ORGANIZATION_CODE", "REJECTED_ILLEGIBLE_DOCUMENT_NAME", "REJECTED_ILLEGIBLE_IDENTIFICATION", "REJECTED_INCOMPLETE_IDENTIFICATION", "REJECTED_INCOMPLETE_REGISTRATION_LETTER", "REJECTED_INCONSISTENT_IDENTITY_CARD", "REJECTED_INCONSISTENT_ORGANIZATION_CODE", "REJECTED_INCONSISTENT_REGISTRANT_NAME", "REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE", "REJECTED_INVALID_DOCUMENT", "REJECTED_MISMATCH_BUSINESS_ID", "REJECTED_MISMATCH_BUSINESS_NAME", "REJECTED_MISMATCH_DOCUMENT_ID", "REJECTED_MISMATCH_DOCUMENT_NAME", "REJECTED_MISMATCH_DOCUMENT_TYPE", "REJECTED_MISMATCH_REGISTRANT_INFO", "REJECTED_MISMATCH_REGISTRANT_LOCALITY", "REJECTED_MISMATCH_REGISTRANT_NAME", "REJECTED_UNABLE_TO_OPEN", "REJECTED_UNABLE_TO_VERIFY", "REJECTED_UNKNOWN_ERROR", "UNABLE_TO_RETRIEVE_STATUS" Content-Type: `application/javascript` Schema: - object - `authCode` (required): string — Authorization code for transferring the Domain - `contactAdmin` (required): object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `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 - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers` (required): array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `status` (required): string — Processing status of the domain - `subaccountId`: string — Reseller subaccount shopperid who can manage the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer - `verifications`: object - `domainName`: object - `status` (required): string — Status of the domain name verification - enum: "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" - `realName`: object - `status` (required): string — Status of the real name verification: - enum: "APPROVED", "PENDING", "REJECTED_DOCUMENT_OUTDATED", "REJECTED_EXPIRED_BUSINESS_LICENSE", "REJECTED_EXPIRED_ORGANIZATION_CODE", "REJECTED_ILLEGIBLE_DOCUMENT_NAME", "REJECTED_ILLEGIBLE_IDENTIFICATION", "REJECTED_INCOMPLETE_IDENTIFICATION", "REJECTED_INCOMPLETE_REGISTRATION_LETTER", "REJECTED_INCONSISTENT_IDENTITY_CARD", "REJECTED_INCONSISTENT_ORGANIZATION_CODE", "REJECTED_INCONSISTENT_REGISTRANT_NAME", "REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE", "REJECTED_INVALID_DOCUMENT", "REJECTED_MISMATCH_BUSINESS_ID", "REJECTED_MISMATCH_BUSINESS_NAME", "REJECTED_MISMATCH_DOCUMENT_ID", "REJECTED_MISMATCH_DOCUMENT_NAME", "REJECTED_MISMATCH_DOCUMENT_TYPE", "REJECTED_MISMATCH_REGISTRANT_INFO", "REJECTED_MISMATCH_REGISTRANT_LOCALITY", "REJECTED_MISMATCH_REGISTRANT_NAME", "REJECTED_UNABLE_TO_OPEN", "REJECTED_UNABLE_TO_VERIFY", "REJECTED_UNKNOWN_ERROR", "UNABLE_TO_RETRIEVE_STATUS" Content-Type: `application/xml` Schema: - object - `authCode` (required): string — Authorization code for transferring the Domain - `contactAdmin` (required): object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `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 - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers` (required): array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `status` (required): string — Processing status of the domain - `subaccountId`: string — Reseller subaccount shopperid who can manage the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer - `verifications`: object - `domainName`: object - `status` (required): string — Status of the domain name verification - enum: "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" - `realName`: object - `status` (required): string — Status of the real name verification: - enum: "APPROVED", "PENDING", "REJECTED_DOCUMENT_OUTDATED", "REJECTED_EXPIRED_BUSINESS_LICENSE", "REJECTED_EXPIRED_ORGANIZATION_CODE", "REJECTED_ILLEGIBLE_DOCUMENT_NAME", "REJECTED_ILLEGIBLE_IDENTIFICATION", "REJECTED_INCOMPLETE_IDENTIFICATION", "REJECTED_INCOMPLETE_REGISTRATION_LETTER", "REJECTED_INCONSISTENT_IDENTITY_CARD", "REJECTED_INCONSISTENT_ORGANIZATION_CODE", "REJECTED_INCONSISTENT_REGISTRANT_NAME", "REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE", "REJECTED_INVALID_DOCUMENT", "REJECTED_MISMATCH_BUSINESS_ID", "REJECTED_MISMATCH_BUSINESS_NAME", "REJECTED_MISMATCH_DOCUMENT_ID", "REJECTED_MISMATCH_DOCUMENT_NAME", "REJECTED_MISMATCH_DOCUMENT_TYPE", "REJECTED_MISMATCH_REGISTRANT_INFO", "REJECTED_MISMATCH_REGISTRANT_LOCALITY", "REJECTED_MISMATCH_REGISTRANT_NAME", "REJECTED_UNABLE_TO_OPEN", "REJECTED_UNABLE_TO_VERIFY", "REJECTED_UNKNOWN_ERROR", "UNABLE_TO_RETRIEVE_STATUS" Content-Type: `text/javascript` Schema: - object - `authCode` (required): string — Authorization code for transferring the Domain - `contactAdmin` (required): object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `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 - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers` (required): array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `status` (required): string — Processing status of the domain - `subaccountId`: string — Reseller subaccount shopperid who can manage the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer - `verifications`: object - `domainName`: object - `status` (required): string — Status of the domain name verification - enum: "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" - `realName`: object - `status` (required): string — Status of the real name verification: - enum: "APPROVED", "PENDING", "REJECTED_DOCUMENT_OUTDATED", "REJECTED_EXPIRED_BUSINESS_LICENSE", "REJECTED_EXPIRED_ORGANIZATION_CODE", "REJECTED_ILLEGIBLE_DOCUMENT_NAME", "REJECTED_ILLEGIBLE_IDENTIFICATION", "REJECTED_INCOMPLETE_IDENTIFICATION", "REJECTED_INCOMPLETE_REGISTRATION_LETTER", "REJECTED_INCONSISTENT_IDENTITY_CARD", "REJECTED_INCONSISTENT_ORGANIZATION_CODE", "REJECTED_INCONSISTENT_REGISTRANT_NAME", "REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE", "REJECTED_INVALID_DOCUMENT", "REJECTED_MISMATCH_BUSINESS_ID", "REJECTED_MISMATCH_BUSINESS_NAME", "REJECTED_MISMATCH_DOCUMENT_ID", "REJECTED_MISMATCH_DOCUMENT_NAME", "REJECTED_MISMATCH_DOCUMENT_TYPE", "REJECTED_MISMATCH_REGISTRANT_INFO", "REJECTED_MISMATCH_REGISTRANT_LOCALITY", "REJECTED_MISMATCH_REGISTRANT_NAME", "REJECTED_UNABLE_TO_OPEN", "REJECTED_UNABLE_TO_VERIFY", "REJECTED_UNKNOWN_ERROR", "UNABLE_TO_RETRIEVE_STATUS" Content-Type: `text/xml` Schema: - object - `authCode` (required): string — Authorization code for transferring the Domain - `contactAdmin` (required): object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `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 - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers` (required): array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `status` (required): string — Processing status of the domain - `subaccountId`: string — Reseller subaccount shopperid who can manage the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer - `verifications`: object - `domainName`: object - `status` (required): string — Status of the domain name verification - enum: "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" - `realName`: object - `status` (required): string — Status of the real name verification: - enum: "APPROVED", "PENDING", "REJECTED_DOCUMENT_OUTDATED", "REJECTED_EXPIRED_BUSINESS_LICENSE", "REJECTED_EXPIRED_ORGANIZATION_CODE", "REJECTED_ILLEGIBLE_DOCUMENT_NAME", "REJECTED_ILLEGIBLE_IDENTIFICATION", "REJECTED_INCOMPLETE_IDENTIFICATION", "REJECTED_INCOMPLETE_REGISTRATION_LETTER", "REJECTED_INCONSISTENT_IDENTITY_CARD", "REJECTED_INCONSISTENT_ORGANIZATION_CODE", "REJECTED_INCONSISTENT_REGISTRANT_NAME", "REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE", "REJECTED_INVALID_DOCUMENT", "REJECTED_MISMATCH_BUSINESS_ID", "REJECTED_MISMATCH_BUSINESS_NAME", "REJECTED_MISMATCH_DOCUMENT_ID", "REJECTED_MISMATCH_DOCUMENT_NAME", "REJECTED_MISMATCH_DOCUMENT_TYPE", "REJECTED_MISMATCH_REGISTRANT_INFO", "REJECTED_MISMATCH_REGISTRANT_LOCALITY", "REJECTED_MISMATCH_REGISTRANT_NAME", "REJECTED_UNABLE_TO_OPEN", "REJECTED_UNABLE_TO_VERIFY", "REJECTED_UNKNOWN_ERROR", "UNABLE_TO_RETRIEVE_STATUS" **203** — Request was partially successful, see verifications.status for further detail Content-Type: `application/json` Schema: - object - `authCode` (required): string — Authorization code for transferring the Domain - `contactAdmin` (required): object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `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 - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers` (required): array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `status` (required): string — Processing status of the domain - `subaccountId`: string — Reseller subaccount shopperid who can manage the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer - `verifications`: object - `domainName`: object - `status` (required): string — Status of the domain name verification - enum: "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" - `realName`: object - `status` (required): string — Status of the real name verification: - enum: "APPROVED", "PENDING", "REJECTED_DOCUMENT_OUTDATED", "REJECTED_EXPIRED_BUSINESS_LICENSE", "REJECTED_EXPIRED_ORGANIZATION_CODE", "REJECTED_ILLEGIBLE_DOCUMENT_NAME", "REJECTED_ILLEGIBLE_IDENTIFICATION", "REJECTED_INCOMPLETE_IDENTIFICATION", "REJECTED_INCOMPLETE_REGISTRATION_LETTER", "REJECTED_INCONSISTENT_IDENTITY_CARD", "REJECTED_INCONSISTENT_ORGANIZATION_CODE", "REJECTED_INCONSISTENT_REGISTRANT_NAME", "REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE", "REJECTED_INVALID_DOCUMENT", "REJECTED_MISMATCH_BUSINESS_ID", "REJECTED_MISMATCH_BUSINESS_NAME", "REJECTED_MISMATCH_DOCUMENT_ID", "REJECTED_MISMATCH_DOCUMENT_NAME", "REJECTED_MISMATCH_DOCUMENT_TYPE", "REJECTED_MISMATCH_REGISTRANT_INFO", "REJECTED_MISMATCH_REGISTRANT_LOCALITY", "REJECTED_MISMATCH_REGISTRANT_NAME", "REJECTED_UNABLE_TO_OPEN", "REJECTED_UNABLE_TO_VERIFY", "REJECTED_UNKNOWN_ERROR", "UNABLE_TO_RETRIEVE_STATUS" Content-Type: `application/javascript` Schema: - object - `authCode` (required): string — Authorization code for transferring the Domain - `contactAdmin` (required): object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `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 - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers` (required): array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `status` (required): string — Processing status of the domain - `subaccountId`: string — Reseller subaccount shopperid who can manage the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer - `verifications`: object - `domainName`: object - `status` (required): string — Status of the domain name verification - enum: "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" - `realName`: object - `status` (required): string — Status of the real name verification: - enum: "APPROVED", "PENDING", "REJECTED_DOCUMENT_OUTDATED", "REJECTED_EXPIRED_BUSINESS_LICENSE", "REJECTED_EXPIRED_ORGANIZATION_CODE", "REJECTED_ILLEGIBLE_DOCUMENT_NAME", "REJECTED_ILLEGIBLE_IDENTIFICATION", "REJECTED_INCOMPLETE_IDENTIFICATION", "REJECTED_INCOMPLETE_REGISTRATION_LETTER", "REJECTED_INCONSISTENT_IDENTITY_CARD", "REJECTED_INCONSISTENT_ORGANIZATION_CODE", "REJECTED_INCONSISTENT_REGISTRANT_NAME", "REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE", "REJECTED_INVALID_DOCUMENT", "REJECTED_MISMATCH_BUSINESS_ID", "REJECTED_MISMATCH_BUSINESS_NAME", "REJECTED_MISMATCH_DOCUMENT_ID", "REJECTED_MISMATCH_DOCUMENT_NAME", "REJECTED_MISMATCH_DOCUMENT_TYPE", "REJECTED_MISMATCH_REGISTRANT_INFO", "REJECTED_MISMATCH_REGISTRANT_LOCALITY", "REJECTED_MISMATCH_REGISTRANT_NAME", "REJECTED_UNABLE_TO_OPEN", "REJECTED_UNABLE_TO_VERIFY", "REJECTED_UNKNOWN_ERROR", "UNABLE_TO_RETRIEVE_STATUS" Content-Type: `application/xml` Schema: - object - `authCode` (required): string — Authorization code for transferring the Domain - `contactAdmin` (required): object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `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 - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers` (required): array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `status` (required): string — Processing status of the domain - `subaccountId`: string — Reseller subaccount shopperid who can manage the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer - `verifications`: object - `domainName`: object - `status` (required): string — Status of the domain name verification - enum: "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" - `realName`: object - `status` (required): string — Status of the real name verification: - enum: "APPROVED", "PENDING", "REJECTED_DOCUMENT_OUTDATED", "REJECTED_EXPIRED_BUSINESS_LICENSE", "REJECTED_EXPIRED_ORGANIZATION_CODE", "REJECTED_ILLEGIBLE_DOCUMENT_NAME", "REJECTED_ILLEGIBLE_IDENTIFICATION", "REJECTED_INCOMPLETE_IDENTIFICATION", "REJECTED_INCOMPLETE_REGISTRATION_LETTER", "REJECTED_INCONSISTENT_IDENTITY_CARD", "REJECTED_INCONSISTENT_ORGANIZATION_CODE", "REJECTED_INCONSISTENT_REGISTRANT_NAME", "REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE", "REJECTED_INVALID_DOCUMENT", "REJECTED_MISMATCH_BUSINESS_ID", "REJECTED_MISMATCH_BUSINESS_NAME", "REJECTED_MISMATCH_DOCUMENT_ID", "REJECTED_MISMATCH_DOCUMENT_NAME", "REJECTED_MISMATCH_DOCUMENT_TYPE", "REJECTED_MISMATCH_REGISTRANT_INFO", "REJECTED_MISMATCH_REGISTRANT_LOCALITY", "REJECTED_MISMATCH_REGISTRANT_NAME", "REJECTED_UNABLE_TO_OPEN", "REJECTED_UNABLE_TO_VERIFY", "REJECTED_UNKNOWN_ERROR", "UNABLE_TO_RETRIEVE_STATUS" Content-Type: `text/javascript` Schema: - object - `authCode` (required): string — Authorization code for transferring the Domain - `contactAdmin` (required): object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `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 - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers` (required): array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `status` (required): string — Processing status of the domain - `subaccountId`: string — Reseller subaccount shopperid who can manage the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer - `verifications`: object - `domainName`: object - `status` (required): string — Status of the domain name verification - enum: "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" - `realName`: object - `status` (required): string — Status of the real name verification: - enum: "APPROVED", "PENDING", "REJECTED_DOCUMENT_OUTDATED", "REJECTED_EXPIRED_BUSINESS_LICENSE", "REJECTED_EXPIRED_ORGANIZATION_CODE", "REJECTED_ILLEGIBLE_DOCUMENT_NAME", "REJECTED_ILLEGIBLE_IDENTIFICATION", "REJECTED_INCOMPLETE_IDENTIFICATION", "REJECTED_INCOMPLETE_REGISTRATION_LETTER", "REJECTED_INCONSISTENT_IDENTITY_CARD", "REJECTED_INCONSISTENT_ORGANIZATION_CODE", "REJECTED_INCONSISTENT_REGISTRANT_NAME", "REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE", "REJECTED_INVALID_DOCUMENT", "REJECTED_MISMATCH_BUSINESS_ID", "REJECTED_MISMATCH_BUSINESS_NAME", "REJECTED_MISMATCH_DOCUMENT_ID", "REJECTED_MISMATCH_DOCUMENT_NAME", "REJECTED_MISMATCH_DOCUMENT_TYPE", "REJECTED_MISMATCH_REGISTRANT_INFO", "REJECTED_MISMATCH_REGISTRANT_LOCALITY", "REJECTED_MISMATCH_REGISTRANT_NAME", "REJECTED_UNABLE_TO_OPEN", "REJECTED_UNABLE_TO_VERIFY", "REJECTED_UNKNOWN_ERROR", "UNABLE_TO_RETRIEVE_STATUS" Content-Type: `text/xml` Schema: - object - `authCode` (required): string — Authorization code for transferring the Domain - `contactAdmin` (required): object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `domain` (required): string — Name of the domain - `domainId` (required): number — Unique identifier for this Domain - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `expires`: string — Date and time when this domain will expire - `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 - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `nameServers` (required): array — Fully-qualified domain names for DNS servers - items: - `privacy`: boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `status` (required): string — Processing status of the domain - `subaccountId`: string — Reseller subaccount shopperid who can manage the domain - `transferProtected`: boolean — Whether or not the domain is protected from transfer - `verifications`: object - `domainName`: object - `status` (required): string — Status of the domain name verification - enum: "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" - `realName`: object - `status` (required): string — Status of the real name verification: - enum: "APPROVED", "PENDING", "REJECTED_DOCUMENT_OUTDATED", "REJECTED_EXPIRED_BUSINESS_LICENSE", "REJECTED_EXPIRED_ORGANIZATION_CODE", "REJECTED_ILLEGIBLE_DOCUMENT_NAME", "REJECTED_ILLEGIBLE_IDENTIFICATION", "REJECTED_INCOMPLETE_IDENTIFICATION", "REJECTED_INCOMPLETE_REGISTRATION_LETTER", "REJECTED_INCONSISTENT_IDENTITY_CARD", "REJECTED_INCONSISTENT_ORGANIZATION_CODE", "REJECTED_INCONSISTENT_REGISTRANT_NAME", "REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE", "REJECTED_INVALID_DOCUMENT", "REJECTED_MISMATCH_BUSINESS_ID", "REJECTED_MISMATCH_BUSINESS_NAME", "REJECTED_MISMATCH_DOCUMENT_ID", "REJECTED_MISMATCH_DOCUMENT_NAME", "REJECTED_MISMATCH_DOCUMENT_TYPE", "REJECTED_MISMATCH_REGISTRANT_INFO", "REJECTED_MISMATCH_REGISTRANT_LOCALITY", "REJECTED_MISMATCH_REGISTRANT_NAME", "REJECTED_UNABLE_TO_OPEN", "REJECTED_UNABLE_TO_VERIFY", "REJECTED_UNKNOWN_ERROR", "UNABLE_TO_RETRIEVE_STATUS" **400** — Request was malformed Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **401** — Authentication info not sent or invalid Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **403** — Authenticated user is not allowed access Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **404** — Resource not found Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **422** — `domain` must be specified Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **429** — Too many requests received within interval Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request **500** — Internal server error Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **Security:** requires `bearerAuth`. ## PATCH /v1/domains/{domain} Update details for the specified Domain Updates one or more fields on the domain. Accepts a partial DomainUpdate body - only fields included are modified. Returns 204 No Content. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `domain` | string | yes | Domain whose details are to be updated | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Shopper-Id` | string | no | 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 (required) Changes to apply to existing Domain Content-Type: `application/json` Schema: - object - `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 - items: - `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`: object - `agreedAt` (required): string — Timestamp indicating when the end-user consented to these agreements - `agreedBy` (required): string — Originating client IP address of the end-user's computer when they consented to the agreements - `agreementKeys` (required): array — Unique identifiers of the agreements to which the end-user has agreed, as required by the elements being updated: - items: - enum: "EXPOSE_REGISTRANT_ORGANIZATION", "EXPOSE_WHOIS" Content-Type: `application/xml` Schema: - object - `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 - items: - `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`: object - `agreedAt` (required): string — Timestamp indicating when the end-user consented to these agreements - `agreedBy` (required): string — Originating client IP address of the end-user's computer when they consented to the agreements - `agreementKeys` (required): array — Unique identifiers of the agreements to which the end-user has agreed, as required by the elements being updated: - items: - enum: "EXPOSE_REGISTRANT_ORGANIZATION", "EXPOSE_WHOIS" Content-Type: `text/xml` Schema: - object - `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 - items: - `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`: object - `agreedAt` (required): string — Timestamp indicating when the end-user consented to these agreements - `agreedBy` (required): string — Originating client IP address of the end-user's computer when they consented to the agreements - `agreementKeys` (required): array — Unique identifiers of the agreements to which the end-user has agreed, as required by the elements being updated: - items: - enum: "EXPOSE_REGISTRANT_ORGANIZATION", "EXPOSE_WHOIS" ### Responses **200** — Request was successful **400** — Request was malformed Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **401** — Authentication info not sent or invalid Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **403** — Specified Subaccount not owned by authenticated Shopper Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **404** — Resource not found Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **409** — The given domain is not eligible to have its nameservers changed Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **422** — - At least two apex (aka @) `nameServers` must be specified - Failed to update nameservers Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **429** — Too many requests received within interval Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request **500** — Internal server error Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **Security:** requires `bearerAuth`. ## DELETE /v1/domains/{domain} Cancel a purchased domain Cancels a purchased domain and initiates a refund if within the cancellation window. This action is irreversible. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `domain` | string | yes | Domain to cancel | ### Responses **200** — Request was successful **400** — Request was malformed Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **401** — Authentication info not sent or invalid Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **403** — Authenticated user is not allowed access Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **404** — The domain does not exist Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **422** — - Unknown domain error - At least two apex (aka @) `nameServers` must be specified Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **429** — Too many requests received within interval Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request **500** — Internal server error Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **Security:** requires `bearerAuth`. ## PATCH /v1/domains/{domain}/contacts Update domain Updates domain settings. Only fields included in the request body are modified. Returns 204 No Content. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `domain` | string | yes | Domain whose Contacts are to be updated. | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Shopper-Id` | string | no | 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 (required) Changes to apply to existing Contacts Content-Type: `application/json` Schema: - object - `contactAdmin`: object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string Content-Type: `application/xml` Schema: - object - `contactAdmin`: object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string Content-Type: `text/xml` Schema: - object - `contactAdmin`: object - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactBilling`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactRegistrant` (required): object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string - `contactTech`: object - `addressMailing` (required): object - `email` (required): string - `fax`: string - `jobTitle`: string - `nameFirst` (required): string - `nameLast` (required): string - `nameMiddle`: string - `organization`: string - `phone` (required): string ### Responses **200** — No response was specified **204** — Request was successful **400** — Request was malformed Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **401** — Authentication info not sent or invalid Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **403** — Authenticated user is not allowed access Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **404** — - Domain not found - Identity document not found Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **422** — `domain` is not a valid Domain name Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **429** — Too many requests received within interval Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request **500** — Internal server error Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **504** — Gateway timeout Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **Security:** requires `bearerAuth`. ## POST /v1/domains/{domain}/verifyRegistrantEmail Re-send Contact E-mail Verification for specified Domain Re-sends the ICANN registrant email verification to the domain's registrant contact. Use when the original verification email was not received or has expired. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `domain` | string | yes | Domain whose Contact E-mail should be verified. | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Shopper-Id` | string | no | 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. | ### Responses **200** — Request was successful **400** — Request was malformed Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **401** — Authentication info not sent or invalid Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **403** — Authenticated user is not allowed access Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **404** — Resource not found Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **422** — `domain` is not a valid Domain name Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **429** — Too many requests received within interval Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request **500** — Internal server error Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **504** — Gateway timeout Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **Security:** requires `bearerAuth`.