curl --request GET \
--url https://api.embedreach.com/api/automations/{id}{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"triggerMetadata": {
"triggerType": "one_time",
"scheduledAt": "<string>",
"timezone": "<string>"
},
"triggerType": "one_time",
"actionData": [
{
"actionType": "send_communication",
"actionMetadata": {
"actionType": "send_communication",
"communicationGroupId": "<string>",
"currentActionId": "<string>",
"nextActionId": "<string>",
"templateActionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customBlockText": "<string>",
"reputationTemplateType": "feedback-request"
}
}
],
"businessId": "<string>",
"status": "draft",
"automationType": "managed",
"includeSegmentIds": [
"<string>"
],
"excludeSegmentIds": [
"<string>"
],
"derivedRevenue": 123,
"derivedOrders": 123,
"extraMergeFieldsInUse": [
{
"id": "<string>",
"type": "static",
"templateName": "<string>",
"displayName": "<string>",
"staticValue": "<string>"
}
]
}
}Get a tenant automation by id
curl --request GET \
--url https://api.embedreach.com/api/automations/{id}{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"triggerMetadata": {
"triggerType": "one_time",
"scheduledAt": "<string>",
"timezone": "<string>"
},
"triggerType": "one_time",
"actionData": [
{
"actionType": "send_communication",
"actionMetadata": {
"actionType": "send_communication",
"communicationGroupId": "<string>",
"currentActionId": "<string>",
"nextActionId": "<string>",
"templateActionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customBlockText": "<string>",
"reputationTemplateType": "feedback-request"
}
}
],
"businessId": "<string>",
"status": "draft",
"automationType": "managed",
"includeSegmentIds": [
"<string>"
],
"excludeSegmentIds": [
"<string>"
],
"derivedRevenue": 123,
"derivedOrders": 123,
"extraMergeFieldsInUse": [
{
"id": "<string>",
"type": "static",
"templateName": "<string>",
"displayName": "<string>",
"staticValue": "<string>"
}
]
}
}If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.
The id of the automation
Status 200 response
Show child attributes
The id of the automation
The name of the automation
The description of the automation
The created at date of the automation
The updated at date of the automation
Show child attributes
one_time String in ISO 8601 format with timezone information (e.g., "2024-03-20T15:00:00-07:00" or "2024-03-20T15:00:00Z")
Timezone in IANA format (e.g., "America/New_York"). This is used for auditing and frontend display. Times are automatically converted to UTC when stored.
one_time, trigger_based, date_based Show child attributes
send_communication, wait_until_next_fixed_time, wait_until_next_occurrence, wait_for_duration, check_segment_membership Show child attributes
send_communication feedback-request, google-review, feedback-request-reminder, google-review-reminder draft, active, running, scheduled, sending, completed, failed, deactivated, cancelled, partially_cancelled, archived managed, custom List of extra merge fields that are attached to this automation that are currently being used in the email/sms content
Show child attributes
The id of the merge field
static The template name of the merge field (e.g. black_friday_coupon)
The display name of the merge field (e.g. "Black Friday Sale 50% off")
The static value of the merge field (e.g. "CODE123")