agreements

Creates, updates, deletes, gets or lists an agreements resource.

Overview

Name	agreements
Type	Resource
Id	godaddy.domains.agreements

Fields

The following fields are returned by SELECT queries:

get_agreement

Request was successful

Name	Datatype	Description
agreementKey	string	Unique identifier for the legal agreement
content	string	Contents of the legal agreement, suitable for embedding
title	string	Title of the legal agreement
url	string (url)	URL to a page containing the legal agreement

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_agreement	select	tlds, privacy	X-Market-Id, forTransfer	Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons

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
privacy	boolean	Whether or not privacy has been requested
tlds	array	list of TLDs whose legal agreements are to be retrieved
X-Market-Id	string (bcp-47)	Unique identifier of the Market used to retrieve/translate Legal Agreements
forTransfer	boolean	Whether or not domain tranfer has been requested

SELECT examples

get_agreement

Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons

SELECT
agreementKey,
content,
title,
url
FROM godaddy.domains.agreements
WHERE tlds = '{{ tlds }}' -- required
AND privacy = '{{ privacy }}' -- required
AND X-Market-Id = '{{ X-Market-Id }}'
AND forTransfer = '{{ forTransfer }}'
;