Update a workflow

Update a workflow’s display properties.

POST /v1/workflows/{workflowId}

Update a workflow

cURL

curl --request POST \
  --url https://app.loops.so/api/v1/workflows/{workflowId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expectedRevisionId": "<string>",
  "name": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://app.loops.so/api/v1/workflows/{workflowId}"

payload = {
    "expectedRevisionId": "<string>",
    "name": "<string>",
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({expectedRevisionId: '<string>', name: '<string>', description: '<string>'})
};

fetch('https://app.loops.so/api/v1/workflows/{workflowId}', 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://app.loops.so/api/v1/workflows/{workflowId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'expectedRevisionId' => '<string>',
    'name' => '<string>',
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://app.loops.so/api/v1/workflows/{workflowId}"

	payload := strings.NewReader("{\n  \"expectedRevisionId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("https://app.loops.so/api/v1/workflows/{workflowId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expectedRevisionId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.loops.so/api/v1/workflows/{workflowId}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expectedRevisionId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}"

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

200

{
  "id": "<string>",
  "workflowRevisionId": "<string>",
  "mailingListId": "<string>",
  "rootNodeId": "<string>",
  "nodes": {
    "cf16k73gq014h3mmj5b6jdi9r": {
      "typeName": "SignupTrigger",
      "nextNodeIds": [
        "cf16k73gq014h3mmj5b4jdifg",
        "cf16k73gq014h3mmj5b4jdifh"
      ]
    }
  },
  "name": "<string>",
  "description": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

To change a workflow’s mailing list, use the Change workflow mailing list endpoint instead. This is because changing mailing lists may remove queued contacts from the workflow.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workflowId · string · required

The ID of the workflow.

Body

application/json

Option 1

Option 2

At least one property must be provided.

expectedRevisionId · string | null · required

The workflow revision token returned by the latest workflow read or mutation. Older workflows may return null before their first revision-aware mutation; pass null back as expectedRevisionId in that case. If the token is stale, the API returns a 409 Conflict error.

name · string · required

The updated workflow name.

description · string

The updated workflow description.

Response

200

application/json

Workflow properties updated.

id · string · required

The ID of the workflow.

workflowRevisionId · string | null · required

The current workflow revision token. Pass the latest value as expectedRevisionId on the next workflow mutation. Will be null for workflows without a revision token yet.

status · enum<string> · required

Available options: Draft, Sending, Paused, PausedAndQueueing

mailingListId · string | null · required

The ID of the mailing list the workflow sends to.

rootNodeId · string · required

The ID of the root node in the workflow graph.

nodes · object · required

A map of node IDs to simplified node objects. Each node includes typeName and nextNodeIds, plus type-specific fields when present. To get the full node object, use the GET /v1/workflows/{workflowId}/nodes/{nodeId} endpoint.

Show child attributes

Example:

{
  "cf16k73gq014h3mmj5b6jdi9r": {
    "typeName": "SignupTrigger",
    "nextNodeIds": [
      "cf16k73gq014h3mmj5b4jdifg",
      "cf16k73gq014h3mmj5b4jdifh"
    ]
  }
}

name · string

The name of the workflow.

description · string

The description of the workflow.