agreements

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

Overview

Name	agreements
Type	Resource
Id	godaddy.agreements.agreements

Fields

The following fields are returned by SELECT queries:

get

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	select	keys	X-Private-Label-Id, X-Market-Id	Retrieve Legal Agreements for provided agreements keys

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
keys	array	Keys for Agreements whose details are to be retrieved
X-Market-Id	string (bcp-47)	Unique identifier of the Market used to retrieve/translate Legal Agreements
X-Private-Label-Id	integer	PrivateLabelId to operate as, if different from JWT

SELECT examples

get

Retrieve Legal Agreements for provided agreements keys

SELECT
agreementKey,
content,
title,
url
FROM godaddy.agreements.agreements
WHERE keys = '{{ keys }}' -- required
AND X-Private-Label-Id = '{{ X-Private-Label-Id }}'
AND X-Market-Id = '{{ X-Market-Id }}'
;