Sign in

v1

latestSwagger 2.02026-07-136573327.3 KB
Notifications

Retrieve the next domain notification

get/v2/customers/{customerId}/domains/notifications

Path parameters

customerIdstring required

The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id.

Headers

X-Request-Idstring

A client provided identifier for tracking this request.

Response

Request was successful

notificationIdstring required

The notification ID to be used in POST /v2/customers/{customerId}/domains/notifications to acknowledge the notification

type'AUTH_CODE_PURCHASE' | 'AUTH_CODE_REGENERATE' | 'AUTO_RENEWAL' | 'BACKORDER' | 'BACKORDER_PURCHASE' | 'BACKORDER_DELETE' | 'BACKORDER_UPDATE' | 'CHANGE_OF_REGISTRANT_DELETE' | 'CONTACT_CREATE' | 'CONTACT_DELETE' | 'CONTACT_UPDATE' | 'DNS_VERIFICATION' | 'DNSSEC_CREATE' | 'DNSSEC_DELETE' | 'DOMAIN_DELETE' | 'DOMAIN_UPDATE' | 'DOMAIN_UPDATE_CONTACTS' | 'DOMAIN_UPDATE_NAME_SERVERS' | 'EXPIRY' | 'HOST_CREATE' | 'HOST_DELETE' | 'ICANN_VERIFICATION' | 'MIGRATE' | 'MIGRATE_IN' | 'PREMIUM' | 'PRIVACY_FORWARDING_UPDATE' | 'PRIVACY_PURCHASE' | 'PRIVACY_DELETE' | 'REDEEM' | 'REGISTER' | 'RENEW' | 'RENEW_UNDO' | 'TRADE' | 'TRADE_CANCEL' | 'TRADE_PURCHASE' | 'TRADE_PURCHASE_AUTH_TEXT_MESSAGE' | 'TRADE_RESEND_AUTH_EMAIL' | 'TRANSFER' | 'TRANSFER_IN' | 'TRANSFER_IN_ACCEPT' | 'TRANSFER_IN_CANCEL' | 'TRANSFER_IN_RESTART' | 'TRANSFER_IN_RETRY' | 'TRANSFER_OUT' | 'TRANSFER_OUT_ACCEPT' | 'TRANSFER_OUT_REJECT' | 'TRANSFER_OUT_REQUESTED' | 'TRANSIT' required

The type of action the notification relates to

resourcestring required

The resource the notification pertains to.

resourceType'CONTACT' | 'DOMAIN' | 'HOST' required

The type of resource the notification relates to

status'AWAITING' | 'CANCELLED' | 'FAILED' | 'PENDING' | 'SUCCESS' required

The resulting status of the action.

addedAtstring iso-datetime required

The date the notification was added

requestIdstring

A client provided identifier (via X-Request-Id header) indicating the request this notification is for

metadataobject

The notification data for the given type as specifed by GET /v2/customers/{customerId}/domains/notifications/schema