Skip to main content
PATCH
/
api
/
automations
/
{id}
Update 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": [
    {
      "actionMetadata": {
        "actionType": "send_communication",
        "communicationGroupId": "<string>",
        "currentActionId": "<string>",
        "nextActionId": "<string>",
        "templateActionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customBlockText": "<string>"
      }
    }
  ],
  "usePointOfContactSender": true,
  "senderProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "triggerMetadata": {
      "triggerType": "one_time",
      "scheduledAt": "<string>",
      "timezone": "<string>"
    },
    "actionData": [
      {
        "actionMetadata": {
          "actionType": "send_communication",
          "communicationGroupId": "<string>",
          "currentActionId": "<string>",
          "nextActionId": "<string>",
          "templateActionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "customBlockText": "<string>"
        }
      }
    ],
    "businessId": "<string>",
    "usePointOfContactSender": true,
    "senderProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Headers

​
reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Body

application/json
​
name
string

A friendly name for the automation

​
description
string

A description for the automation

​
trigger
object

The trigger for the automation

​
includeSegments
string[]

The segments to include in the automation

​
excludeSegments
string[] | null

The segments to exclude from the automation

​
action
object[]

The action for the automation

​
status
enum<string>

The status of the automation

Available options:
draft,
active,
completed,
cancelled,
partially_cancelled,
archived,
sending
​
usePointOfContactSender
boolean | null

When true (and partner enables point-of-contact sender), the send path will attempt to use the mapped point-of-contact for the customer as the From/reply-to. When false will use the default email sender. Null/omitted is treated as false at send time.

​
senderProfileId
string<uuid> | null

Response

Status 200 response

​
success
boolean
required
​
message
string
​
data
object