notification_opt_ins_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	notification_opt_ins_v2
Type	Resource
Id	godaddy.domains.notification_opt_ins_v2

Fields

The following fields are returned by SELECT queries:

list

Request was successful

Name	Datatype	Description
notification_id	string	The notification ID to be used in POST /v2/customers/{customerId}/domains/notifications to acknowledge the notification (default: ) (wire: notificationId)
request_id	string	A client provided identifier (via X-Request-Id header) indicating the request this notification is for (wire: requestId)
added_at	string (iso-datetime)	The date the notification was added (default: ) (wire: addedAt)
metadata	string	The notification data for the given type as specified by GET /v2/customers/{customerId}/domains/notifications/schema (opaque JSON object) (default: )
resource	string	The resource the notification pertains to. (default: )
resource_type	string	The type of resource the notification relates to (CONTACT, DOMAIN, HOST) (wire: resourceType)
status	string	The resulting status of the action. (AWAITING, CANCELLED, FAILED, PENDING, SUCCESS)
type	string	The type of action the notification relates to (AUTH_CODE_REGENERATE, AUTO_RENEWAL, CHANGE_OF_REGISTRANT_DELETE, DOMAIN_DELETE, DOMAIN_UPDATE, DOMAIN_UPDATE_NAME_SERVERS, PRIVACY_FORWARDING_UPDATE, REGISTER, TRANSFER, TRANSFER_IN, TRANSFER_IN_ACCEPT, TRANSFER_IN_CANCEL, TRANSFER_IN_RESTART, TRANSFER_IN_RETRY, TRANSFER_OUT, TRANSFER_OUT_ACCEPT, TRANSFER_OUT_REJECT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	customer_id	x_request_id	Returns the notification types the account is currently opted in to receive.
replace	exec	types, customer_id	x_request_id	Opts the account in to receiving the specified notification types. Returns 204 No Content.

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.
types	array	The notification types that should be opted in
x_request_id	string	A client provided identifier for tracking this request.
x_request_id	string	A client provided identifier for tracking this request. (wire: X-Request-Id)

SELECT examples

list

Returns the notification types the account is currently opted in to receive.

SELECT
notification_id,
request_id,
added_at,
metadata,
resource,
resource_type,
status,
type
FROM godaddy.domains.notification_opt_ins_v2
WHERE x_request_id = '{{ x_request_id }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

replace

Opts the account in to receiving the specified notification types. Returns 204 No Content.

EXEC godaddy.domains.notification_opt_ins_v2.replace 
@customer_id='{{ customer_id }}' --required unless GODADDY_CUSTOMER_ID is set, 
@types='{{ types }}' --required, 
@x_request_id='{{ x_request_id }}'
;