Email Integration

Fetch a emailIntegration

get/integration/email/{emailIntegrationId}/fetch

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/integration/email/{emailIntegrationId}/fetch
  • Auth: HTTP bearer

Path parameters

emailIntegrationIdstring required

The ID of the Email integration to retrieve

Response

The Email integration was retrieved successfully

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

idstring required

The instance ID

createdAtnumber required

The timestamp (ms) when the instance was created

updatedAtnumber required

The timestamp (ms) when the instance was updated

botIdstring nullable

The ID of the bot this configuration is using

blueprintIdstring nullable

The ID of the blueprint

contactCollectionboolean

Weather to collect contacts

sessionDurationnumber

The session duration (in milliseconds)

attachmentsboolean

Weather the bot supports attachments

allowFromstring

Newline-separated list of email patterns allowed to send messages to this integration

Changes

No recorded changes to this operation across all 1 revision of this API.