createAddress

abstract fun createAddress(description: String, generatedFor: String, usedOn: String): RelayAddress

Creates a new Relay mask (alias) with the specified metadata.

This is used to generate a new alias for use in an email field.

description: A label shown in the Relay dashboard; defaults to generated_for, user-editable later.
generated_for: The website for which the address is generated.
used_on: Comma-separated list of all websites where this address is used. Only updated by some clients.

Errors

RelayApi: Returned for any non-successful (non-2xx) HTTP response. Provides the HTTP status and response body; downstream consumers can inspect these fields. If the response body is JSON with error_code or detail fields, these are parsed and included for more granular handling; otherwise, the raw response text is used as the error detail.
Network: Returned for transport-level failures, like loss of connectivity, with details in reason.
Other variants may be returned for unexpected deserialization, URL, or backend errors.