Leave the end user's email address on a connection
Leave the end user's email address on a connection: CustomDomain™ API reference in the connections group. Covers parameters, request body and responses.
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.
Short-lived widget JWT minted server-side via POST /v1/tokens. Scoped to one application (and optionally one domain).
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/connections/string/end-user-email" \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected]" }'{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}