Update Tenant Automation

Update a tenant automation

PATCH /api/automations/{id}

Update Tenant Automation

cURL

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"
}
'

import requests

url = "https://api.embedreach.com/api/automations/{id}"

payload = {
    "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"
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.embedreach.com/api/automations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.embedreach.com/api/automations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.embedreach.com/api/automations/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"trigger\": {\n    \"triggerType\": \"one_time\",\n    \"scheduledAt\": \"<string>\",\n    \"timezone\": \"<string>\"\n  },\n  \"includeSegments\": [\n    \"<string>\"\n  ],\n  \"excludeSegments\": [\n    \"<string>\"\n  ],\n  \"action\": [\n    {\n      \"actionMetadata\": {\n        \"actionType\": \"send_communication\",\n        \"communicationGroupId\": \"<string>\",\n        \"currentActionId\": \"<string>\",\n        \"nextActionId\": \"<string>\",\n        \"templateActionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"customBlockText\": \"<string>\"\n      }\n    }\n  ],\n  \"usePointOfContactSender\": true,\n  \"senderProfileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.embedreach.com/api/automations/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"trigger\": {\n    \"triggerType\": \"one_time\",\n    \"scheduledAt\": \"<string>\",\n    \"timezone\": \"<string>\"\n  },\n  \"includeSegments\": [\n    \"<string>\"\n  ],\n  \"excludeSegments\": [\n    \"<string>\"\n  ],\n  \"action\": [\n    {\n      \"actionMetadata\": {\n        \"actionType\": \"send_communication\",\n        \"communicationGroupId\": \"<string>\",\n        \"currentActionId\": \"<string>\",\n        \"nextActionId\": \"<string>\",\n        \"templateActionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"customBlockText\": \"<string>\"\n      }\n    }\n  ],\n  \"usePointOfContactSender\": true,\n  \"senderProfileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.embedreach.com/api/automations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"trigger\": {\n    \"triggerType\": \"one_time\",\n    \"scheduledAt\": \"<string>\",\n    \"timezone\": \"<string>\"\n  },\n  \"includeSegments\": [\n    \"<string>\"\n  ],\n  \"excludeSegments\": [\n    \"<string>\"\n  ],\n  \"action\": [\n    {\n      \"actionMetadata\": {\n        \"actionType\": \"send_communication\",\n        \"communicationGroupId\": \"<string>\",\n        \"currentActionId\": \"<string>\",\n        \"nextActionId\": \"<string>\",\n        \"templateActionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"customBlockText\": \"<string>\"\n      }\n    }\n  ],\n  \"usePointOfContactSender\": true,\n  \"senderProfileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "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"
  }
}

{
  "message": "<string>",
  "success": false,
  "errors": [
    "<string>"
  ]
}

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

Option 1

Option 2

Option 3

Show child attributes

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

Show child attributes

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

200

application/json

Status 200 response

success · boolean · required

message · string

data · object

Show child attributes