curl --request PATCH \
--url https://api.embedreach.com/api/automations/{id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"trigger": {
"triggerType": "one_time",
"scheduledAt": "<string>",
"timezone": "<string>"
},
"includeSegments": [
"<string>"
],
"excludeSegments": [
"<string>"
],
"action": [
{
"actionType": "send_communication",
"actionMetadata": {
"actionType": "send_communication",
"communicationGroupId": "<string>",
"currentActionId": "<string>",
"nextActionId": "<string>",
"templateActionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customBlockText": "<string>",
"reputationTemplateType": "feedback-request"
}
}
],
"status": "draft"
}
'{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"name": "<string>",
"description": "<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"
}
}
],
"status": "draft",
"businessId": "<string>"
}
}Update a tenant automation
curl --request PATCH \
--url https://api.embedreach.com/api/automations/{id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"trigger": {
"triggerType": "one_time",
"scheduledAt": "<string>",
"timezone": "<string>"
},
"includeSegments": [
"<string>"
],
"excludeSegments": [
"<string>"
],
"action": [
{
"actionType": "send_communication",
"actionMetadata": {
"actionType": "send_communication",
"communicationGroupId": "<string>",
"currentActionId": "<string>",
"nextActionId": "<string>",
"templateActionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customBlockText": "<string>",
"reputationTemplateType": "feedback-request"
}
}
],
"status": "draft"
}
'{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"name": "<string>",
"description": "<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"
}
}
],
"status": "draft",
"businessId": "<string>"
}
}If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.
A friendly name for the automation
A description for the automation
The trigger for 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.
The segments to include in the automation
The segments to exclude from the automation
The action for the automation
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 The status of the automation
draft, active, deactivated, completed, cancelled, partially_cancelled, archived, sending Status 200 response
Show child attributes
The id of the automation
The name of the automation
The description 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