Connections

Leave the end user's email address on a connection

The widget's optional "Get DNS updates by email" field. After a domain is set up, the end user can leave an address so they hear if its records ever need to change (one email, with the new records, sent on the platform's behalf).

A widget token for the connection's own application can set an address only while the connection has none: when one is already there (the platform's, or an earlier one) the answer is 409, so a browser can never overwrite what the platform gave. An API key replaces any earlier address. The address is never echoed back and never logged.

Test domains refuse the call.

put/connections/{id}/end-user-email

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/connections/{id}/end-user-email
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Request body

emailstring email required

Response

Stored (or dropped while the feature is off)

Changes

No recorded changes to this operation across all 1 revision of this API.