domains

POST /v1/domains/{domainId}/email-routing/addresses

Register a destination address.

Tous les points de terminaison domains

Toute la documentation pour développeurs

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation domains.dns.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/email-routing/addresses \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "email": <string> }'

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

This sends mail to a third party. The provider emails the address a verification link and will not deliver anything to it until the recipient clicks, so the response carries verified: false rather than pretending the destination is usable. Destination addresses are account-scoped at the provider, not zone-scoped: one address book serves every domain on the account. Requires domains.dns.manage.

Paramètres

NomTypeObligatoireQu'est-ce que c'est
domainId (path)UuidOuiThe domain's id.

Corps de la requête

NomTypeObligatoireQu'est-ce que c'est
emailstringOuiThe provider emails this address a verification link. It is a write that reaches a third party, so it is permissioned and audit-logged accordingly.

Réponse

NomTypeObligatoireQu'est-ce que c'est
address_idstringOui
emailstringOui
verifiedbooleanOuiA fact about the recipient's action, never ours: the provider emails a verification link and will not deliver until it is clicked.
createdstringOui

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422 · 429 · 503