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

Delete email delivery

DEPRECATED

Delete email delivery

delete

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

No Content

delete/portals/{portalId}/email-delivery
 

Get the email config for the portal

Retrieve the email config for the portal

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Portal email config.

PortalEmailConfig

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

domain_namestring | null

The domain name used for sending emails. Null means default.

from_namestring | nullrequired

The name displayed in the ‘From’ field of emails.

from_emailstring | null(email)required

The email address used in the ‘From’ field.

reply_to_emailstring | null(email)required

The email address used in the ‘Reply-To’ field. ‘Reply-To’ header is omitted when null.

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-config
 
application/json

Create the email config for a portal

Create the email config for a portal

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Create a portal email configuration.

PostPortalEmailConfig

* Additional properties are NOT allowed.
domain_namestring | null

The domain name to use for sending emails. Null means default.

from_namestring | null

The name to display in the ‘From’ field of emails.

from_emailstring | null(email)

The email address to use in the ‘From’ field.

reply_to_emailstring | null(email)

The email address to use in the ‘Reply-To’ field. ‘Reply-To’ header is omitted if omitted or null.

Response

application/json

Portal email config.

PortalEmailConfig

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

domain_namestring | null

The domain name used for sending emails. Null means default.

from_namestring | nullrequired

The name displayed in the ‘From’ field of emails.

from_emailstring | null(email)required

The email address used in the ‘From’ field.

reply_to_emailstring | null(email)required

The email address used in the ‘Reply-To’ field. ‘Reply-To’ header is omitted when null.

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/{portalId}/email-config

Body

{ "domain_name": "example.com", "from_name": "Gandalf", "from_email": "user@example.com", "reply_to_email": "admin@example.com" }
 
application/json

Setup the email config for a portal

Setup the email config for a portal

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Update a portal email configured.

PatchPortalEmailConfig

* Additional properties are NOT allowed.
domain_namestring | null

The domain name to use for sending emails. Null means default.

from_namestring | null

The name to display in the ‘From’ field of emails.

from_emailstring | null(email)

The email address to use in the ‘From’ field.

reply_to_emailstring | null(email)

The email address to use in the ‘Reply-To’ field. If set to null, ‘Reply-To’ header is omitted.

Response

application/json

Portal email config.

PortalEmailConfig

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

domain_namestring | null

The domain name used for sending emails. Null means default.

from_namestring | nullrequired

The name displayed in the ‘From’ field of emails.

from_emailstring | null(email)required

The email address used in the ‘From’ field.

reply_to_emailstring | null(email)required

The email address used in the ‘Reply-To’ field. ‘Reply-To’ header is omitted when null.

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-config

Body

{ "domain_name": "example.com", "from_name": "Gandalf", "from_email": "user@example.com", "reply_to_email": "admin@example.com" }
 
application/json