Update an automation

PATCH/automations/{automation_id}Update an automation

Parameters

automation_idstring · uuidpathrequired

The ID of the automation.

Request body

application/json

objectPatchAutomationRequest

At least one of `name`, `status`, or `steps` and `connections` must be provided. When updating the workflow graph, both `steps` and `connections` must be provided together.

connectionsarray of object

The connections between steps in the automation graph. Must be provided together with `steps`.

Show child attributes

Show array items

A connection between two steps in the automation graph.

fromstringrequired

The `key` of the source step.

tostringrequired

The `key` of the target step.

typestring

The type of connection. Defaults to `default`.

one of "default", "condition_met", "condition_not_met", "timeout", "event_received" · default "default"

namestring

The name of the automation.

minLength 1

statusstring

The status of the automation.

one of "enabled", "disabled"

stepsarray of object

The steps that compose the automation workflow. Must be provided together with `connections`.

maxItems 150 · minItems 1

Show child attributes

maxItems 150 · minItems 1

Show array items

A step in an automation workflow. The `config` object varies based on the step `type`.

configobjectrequired

Configuration for the step. Shape depends on `type`: - **trigger**: `{ event_name: string }` - **send_email**: `{ template: { id: string, variables?: object }, subject?: string, from?: string, reply_to?: string }` - **delay**: `{ duration: string }` — a human-readable duration (e.g. `"30 minutes"`) - **wait_for_event**: `{ event_name: string, timeout?: string, filter_rule?: object }` — `timeout` is a human-readable duration (e.g. `"1 hour"`) - **condition**: A rule tree with `type` (`rule`, `and`, `or`), `field`, `operator`, and `value` - **contact_update**: `{ first_name?: string|object, last_name?: string|object, unsubscribed?: boolean|object, properties?: object }` - **contact_delete**: `{}` - **add_to_segment**: `{ segment_id: string }`

keystringrequired

A unique key for this step within the automation graph.

typestringrequired

The type of automation step.

one of "trigger", "send_email", "delay", "wait_for_event", "condition", "contact_update", "contact_delete", "add_to_segment"

Example request

{
  "connections": [
    {
      "from": "string",
      "to": "string",
      "type": "default"
    }
  ],
  "name": "string",
  "status": "disabled",
  "steps": [
    {
      "config": {},
      "key": "string",
      "type": "add_to_segment"
    }
  ]
}

Responses

objectPatchAutomationResponse

idstring

The ID of the updated automation.

objectstring

Type of the response object.

Example response

{
  "id": "string",
  "object": "automation"
}

Examples

automation_idrequiredpath parameter

curl -X PATCH 'https://api.resend.com/automations/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{"connections":[{"from":"string","to":"string","type":"default"}],"name":"string","status":"disabled","steps":[{"config":{},"key":"string","type":"add_to_segment"}]}'

const response = await fetch('https://api.resend.com/automations/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"connections":[{"from":"string","to":"string","type":"default"}],"name":"string","status":"disabled","steps":[{"config":{},"key":"string","type":"add_to_segment"}]}),
});
const data = await response.json();

const response = await fetch('https://api.resend.com/automations/00000000-0000-0000-0000-000000000000', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"connections\":[{\"from\":\"string\",\"to\":\"string\",\"type\":\"default\"}],\"name\":\"string\",\"status\":\"disabled\",\"steps\":[{\"config\":{},\"key\":\"string\",\"type\":\"add_to_segment\"}]}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://api.resend.com/automations/00000000-0000-0000-0000-000000000000",
    headers={"Content-Type": "application/json"},
    data='{"connections":[{"from":"string","to":"string","type":"default"}],"name":"string","status":"disabled","steps":[{"config":{},"key":"string","type":"add_to_segment"}]}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"connections":[{"from":"string","to":"string","type":"default"}],"name":"string","status":"disabled","steps":[{"config":{},"key":"string","type":"add_to_segment"}]}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://api.resend.com/automations/00000000-0000-0000-0000-000000000000", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.resend.com/automations/00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"connections\":[{\"from\":\"string\",\"to\":\"string\",\"type\":\"default\"}],\"name\":\"string\",\"status\":\"disabled\",\"steps\":[{\"config\":{},\"key\":\"string\",\"type\":\"add_to_segment\"}]}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.resend.com/automations/00000000-0000-0000-0000-000000000000"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"connections\":[{\"from\":\"string\",\"to\":\"string\",\"type\":\"default\"}],\"name\":\"string\",\"status\":\"disabled\",\"steps\":[{\"config\":{},\"key\":\"string\",\"type\":\"add_to_segment\"}]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.resend.com/automations/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"connections\":[{\"from\":\"string\",\"to\":\"string\",\"type\":\"default\"}],\"name\":\"string\",\"status\":\"disabled\",\"steps\":[{\"config\":{},\"key\":\"string\",\"type\":\"add_to_segment\"}]}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.resend.com/automations/00000000-0000-0000-0000-000000000000");
request.Content = new StringContent("{\"connections\":[{\"from\":\"string\",\"to\":\"string\",\"type\":\"default\"}],\"name\":\"string\",\"status\":\"disabled\",\"steps\":[{\"config\":{},\"key\":\"string\",\"type\":\"add_to_segment\"}]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "id": "string",
  "object": "automation"
}

Search documentation

Emails

Domains

Audiences

Contacts

Receiving Emails

Webhooks

Templates

Broadcasts

Segments

Topics

Contact Properties

Logs

Automations

Events

API keys