Create an email domain

Create an email domain

post

Body

application/json

EmailDomainPayload

* Additional properties are NOT allowed.
domainstringrequired

Response

application/json

success

EmailDomain

* Additional properties are NOT allowed.
domainstringrequired
verificationobjectrequiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
dns_validation_recordsarray[object]requiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/portals/email-domains

Body

{ "domain": "domain" }
 
application/json

Get an email domain

Get an email domain

get

Path Parameters

emailDomainstringrequired

Email domain for custom portal email sender

Response

application/json

success

EmailDomain

* Additional properties are NOT allowed.
domainstringrequired
verificationobjectrequiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
dns_validation_recordsarray[object]requiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/portals/email-domains/{emailDomain}
 
application/json

Delete an email domain

Delete an email domain

delete

Path Parameters

emailDomainstringrequired

Email domain for custom portal email sender

Response

No Content

delete/portals/email-domains/{emailDomain}
 

Get the email delivery for the portal

DEPRECATED

Retrieve the email delivery for the portal

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

success

EmailDelivery

* Additional properties are NOT allowed.
enabledbooleanrequired
from_emailstring | null(email)required
reply_to_emailstring | null(email)required
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/portals/{portalId}/email-delivery
 
application/json

Setup the email delivery for a portal

DEPRECATED

Setup the email delivery for a portal

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

EmailDeliveryUpdatePayload

* Additional properties are NOT allowed.
enabledboolean
from_emailstring | null(email)
reply_to_emailstring | null(email)

Response

application/json

success

EmailDelivery

* Additional properties are NOT allowed.
enabledbooleanrequired
from_emailstring | null(email)required
reply_to_emailstring | null(email)required
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

patch/portals/{portalId}/email-delivery

Body

{}
 
application/json