Portal Emails

Create the email config for a portal

Changed on

Create the email config for a portal

post/v3/portals/{portalId}/email-config

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/email-config
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

domain_namestring nullable

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

from_namestring nullable

The name to display in the 'From' field of emails.

from_emailstring email nullable

The email address to use in the 'From' field.

reply_to_emailstring email nullable

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

Response

Portal email config.

idstring uuid required
domain_namestring nullable

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

from_namestring nullable required

The name displayed in the 'From' field of emails.

from_emailstring email nullable required

The email address used in the 'From' field.

reply_to_emailstring email nullable required

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

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status

    • warning

      added the new 409.00 enum value to the response property for the response status