registrant_changes_v2
GoDaddy Domains v2 API, scoped to a customer: customer_id is resolved from the GODADDY_CUSTOMER_ID environment variable when set, otherwise it is a required parameter (a WHERE value always wins). Accepts a Personal Access Token (Bearer) or a classic sso-key credential.
Overview
| Name | registrant_changes_v2 |
| Type | Resource |
| Id | godaddy.domains.registrant_changes_v2 |
Fields
The following fields are returned by SELECT queries:
- get
Request was successful
| Name | Datatype | Description |
|---|---|---|
create_date | string (iso-datetime) | (wire: createDate) |
gaining_contact | object | (wire: gainingContact) |
losing_contact | object | (wire: losingContact) |
other_domains_affected | integer (integer-positive) | (wire: otherDomainsAffected) |
shopper_email | string (email) | (wire: shopperEmail) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | domain, customer_id | x_request_id | Returns current change of registrant details including status, requested contacts, and any pending approvals. |
cancel | delete | domain, customer_id | x_request_id | Cancels a pending change of registrant. Returns 202 - poll GET .../actions/CHANGE_OF_REGISTRANT_DELETE until COMPLETED, FAILED, or CANCELLED. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
customer_id | string (uuid) | GoDaddy customer identifier (UUID, not the numeric shopper number). Resolved from the GODADDY_CUSTOMER_ID environment variable when it is set (server variable, x-stackQL-envVar); otherwise required on every method of this resource. A WHERE value always takes precedence over the environment. API resellers acting on behalf of a subaccount pass the subaccount customer identifier. |
domain | string | Domain whose change of registrant is to be cancelled |
x_request_id | string | A client provided identifier for tracking this request. (wire: X-Request-Id) |
SELECT examples
- get
Returns current change of registrant details including status, requested contacts, and any pending approvals.
SELECT
create_date,
gaining_contact,
losing_contact,
other_domains_affected,
shopper_email
FROM godaddy.domains.registrant_changes_v2
WHERE domain = '{{ domain }}' -- required
AND customer_id = '{{ customer_id }}' -- required unless GODADDY_CUSTOMER_ID is set
AND x_request_id = '{{ x_request_id }}'
;
DELETE examples
- cancel
Cancels a pending change of registrant. Returns 202 - poll GET .../actions/CHANGE_OF_REGISTRANT_DELETE until COMPLETED, FAILED, or CANCELLED.
DELETE FROM godaddy.domains.registrant_changes_v2
WHERE domain = '{{ domain }}' --required
AND customer_id = '{{ customer_id }}' -- required unless GODADDY_CUSTOMER_ID is set
AND x_request_id = '{{ x_request_id }}'
;