Portal Emails

APIs related to Konnect Developer Portal Emails.

List email domains

List email domains

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

sortstring

Sorts a collection of email domains. Supported sort attributes are:

  • domain
  • created_at
  • updated_at
filterobject

Filter email domains returned in the response.

Show Child Parameters

Response

application/json

List of a email domains

ListDomains

dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/portals/email-domains
 
application/json

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}