Alpha Email Automation
Email Automation Configuration API
Get or create email automation config
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/communications/automation/config"{
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"tenantId": "string",
"triggerConfigs": [
{
"enabled": true,
"templateId": "string",
"triggerType": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update email automation config
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/communications/automation/config" \ -H "Content-Type: application/json" \ -d '{ "triggerConfigs": [ { "enabled": true, "triggerType": "string" } ] }'{
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"tenantId": "string",
"triggerConfigs": [
{
"enabled": true,
"templateId": "string",
"triggerType": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}List all available trigger type definitions
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/communications/automation/trigger-types"[
{
"category": "CRM",
"description": "string",
"displayName": "string",
"isTimeBased": true,
"key": "string",
"variables": [
"string"
]
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}