POST /v1/partner/customers/{externalId}/registrant-email-reminders

Authentication

Send an API key as a bearer token. The key must carry the partner.domains permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/partner/customers/{externalId}/registrant-email-reminders \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "registrant_email": <string>, "deadline_at": <string>, "stage": <string>, "sent_at": <string> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

When a customer's registrant e-mail is unconfirmed at the registrar you receive a domain.registrant_email_flagged event on /v1/partner/events carrying registrant_email, deadline_at (when the registry suspends the names), suspended, domain_count and domains. Remind your customer, then report each reminder here so our staff can see that it went, and when — rather than assume it. Recorded, never sent on to the customer. When every listed name reads verified at the registrar you receive domain.registrant_email_confirmed (same fields) once: stop reminding. Requires partner.domains.

Parameters

Request body

Response

Errors this endpoint can return

401 · 403 · 404 · 422 · 429