transfers_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	transfers_v2
Type	Resource
Id	godaddy.transfers.transfers_v2

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
transfer_in	exec	domain, auth_code, consent, customer_id	x_request_id	Initiates an inbound domain transfer from another registrar. Requires an authcode and consent object. Returns 202 - poll GET .../actions/TRANSFER until COMPLETED, FAILED, or CANCELLED.
accept_transfer_in	exec	domain, auth_code, customer_id	x_request_id	Explicitly accepts an in-progress inbound transfer to expedite the process. Returns 202 - poll GET .../actions/TRANSFER_IN_ACCEPT until the action reaches a terminal state.
cancel_transfer_in	exec	domain, customer_id	x_request_id	Cancels an in-progress inbound transfer. Returns 202 - poll GET .../actions/TRANSFER_IN_CANCEL until the action reaches a terminal state.
restart_transfer_in	exec	domain, customer_id	x_request_id	Restarts a stalled inbound transfer from the beginning. Returns 202 - poll GET .../actions/TRANSFER_IN_RESTART until the action reaches a terminal state.
retry_transfer_in	exec	domain, auth_code, customer_id	x_request_id	Retries a failed inbound transfer with a new authorization code. Returns 202 - poll GET .../actions/TRANSFER_IN_RETRY until the action reaches a terminal state.
transfer_out	exec	domain, registrar, customer_id	x_request_id	Initiates an outbound transfer for .uk domains. Returns 202 - poll the actions endpoint for completion.
accept_transfer_out	exec	domain, customer_id	x_request_id	Accepts a pending outbound transfer request. Returns 202 - poll GET .../actions/TRANSFER_OUT_ACCEPT until the action reaches a terminal state.
reject_transfer_out	exec	domain, customer_id	x_request_id, reason	Rejects a pending outbound transfer request, keeping the domain at GoDaddy. Returns 202 - poll GET .../actions/TRANSFER_OUT_REJECT until the action reaches a terminal state.

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 to reject the transfer out for
registrar	string	Registrar tag to push transfer to
x_request_id	string	A client provided identifier for tracking this request.
reason	string	Transfer out reject reason

Lifecycle Methods

EXEC variables use wire (API) names.

transfer_in

Initiates an inbound domain transfer from another registrar. Requires an authcode and consent object. Returns 202 - poll GET .../actions/TRANSFER until COMPLETED, FAILED, or CANCELLED.

EXEC godaddy.transfers.transfers_v2.transfer_in 
@customer_id='{{ customer_id }}' --required unless GODADDY_CUSTOMER_ID is set, 
@domain='{{ domain }}' --required, 
@x_request_id='{{ x_request_id }}', 
@auth_code='{{ auth_code }}', 
@period='{{ period }}', 
@renew_auto='{{ renew_auto }}', 
@privacy='{{ privacy }}', 
@identity_document_id='{{ identity_document_id }}', 
@consent='{{ consent }}', 
@contacts='{{ contacts }}', 
@metadata='{{ metadata }}'
;

accept_transfer_in

Explicitly accepts an in-progress inbound transfer to expedite the process. Returns 202 - poll GET .../actions/TRANSFER_IN_ACCEPT until the action reaches a terminal state.

EXEC godaddy.transfers.transfers_v2.accept_transfer_in 
@customer_id='{{ customer_id }}' --required unless GODADDY_CUSTOMER_ID is set, 
@domain='{{ domain }}' --required, 
@x_request_id='{{ x_request_id }}', 
@auth_code='{{ auth_code }}'
;

cancel_transfer_in

Cancels an in-progress inbound transfer. Returns 202 - poll GET .../actions/TRANSFER_IN_CANCEL until the action reaches a terminal state.

EXEC godaddy.transfers.transfers_v2.cancel_transfer_in 
@customer_id='{{ customer_id }}' --required unless GODADDY_CUSTOMER_ID is set, 
@domain='{{ domain }}' --required, 
@x_request_id='{{ x_request_id }}'
;

restart_transfer_in

Restarts a stalled inbound transfer from the beginning. Returns 202 - poll GET .../actions/TRANSFER_IN_RESTART until the action reaches a terminal state.

EXEC godaddy.transfers.transfers_v2.restart_transfer_in 
@customer_id='{{ customer_id }}' --required unless GODADDY_CUSTOMER_ID is set, 
@domain='{{ domain }}' --required, 
@x_request_id='{{ x_request_id }}'
;

retry_transfer_in

Retries a failed inbound transfer with a new authorization code. Returns 202 - poll GET .../actions/TRANSFER_IN_RETRY until the action reaches a terminal state.

EXEC godaddy.transfers.transfers_v2.retry_transfer_in 
@customer_id='{{ customer_id }}' --required unless GODADDY_CUSTOMER_ID is set, 
@domain='{{ domain }}' --required, 
@x_request_id='{{ x_request_id }}', 
@auth_code='{{ auth_code }}'
;

transfer_out

Initiates an outbound transfer for .uk domains. Returns 202 - poll the actions endpoint for completion.

EXEC godaddy.transfers.transfers_v2.transfer_out 
@customer_id='{{ customer_id }}' --required unless GODADDY_CUSTOMER_ID is set, 
@domain='{{ domain }}' --required, 
@registrar='{{ registrar }}' --required, 
@x_request_id='{{ x_request_id }}'
;

accept_transfer_out

Accepts a pending outbound transfer request. Returns 202 - poll GET .../actions/TRANSFER_OUT_ACCEPT until the action reaches a terminal state.

EXEC godaddy.transfers.transfers_v2.accept_transfer_out 
@customer_id='{{ customer_id }}' --required unless GODADDY_CUSTOMER_ID is set, 
@domain='{{ domain }}' --required, 
@x_request_id='{{ x_request_id }}'
;

reject_transfer_out

Rejects a pending outbound transfer request, keeping the domain at GoDaddy. Returns 202 - poll GET .../actions/TRANSFER_OUT_REJECT until the action reaches a terminal state.

EXEC godaddy.transfers.transfers_v2.reject_transfer_out 
@customer_id='{{ customer_id }}' --required unless GODADDY_CUSTOMER_ID is set, 
@domain='{{ domain }}' --required, 
@x_request_id='{{ x_request_id }}', 
@reason='{{ reason }}'
;