Update Workflow Schedule

curl --request PATCH \
  --url https://api-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scheduled_time": "2023-11-07T05:31:56Z",
  "run_input": {
    "dynamic_variables": {},
    "runtime_variables": {},
    "miscellaneous": {},
    "command": "start",
    "workflow_id": "5eb7cf5a86d9755df3a6c593",
    "version_number": 0,
    "run_by": "<string>",
    "workflow_run_id": "5eb7cf5a86d9755df3a6c593",
    "team_id": "<string>",
    "start_node_logical_id": "<string>",
    "initial_state": {},
    "thread_to_node_inputs": {},
    "welcome_message": "<string>"
  },
  "version": 123
}
'

import requests

url = "https://api-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_id}"

payload = {
    "scheduled_time": "2023-11-07T05:31:56Z",
    "run_input": {
        "dynamic_variables": {},
        "runtime_variables": {},
        "miscellaneous": {},
        "command": "start",
        "workflow_id": "5eb7cf5a86d9755df3a6c593",
        "version_number": 0,
        "run_by": "<string>",
        "workflow_run_id": "5eb7cf5a86d9755df3a6c593",
        "team_id": "<string>",
        "start_node_logical_id": "<string>",
        "initial_state": {},
        "thread_to_node_inputs": {},
        "welcome_message": "<string>"
    },
    "version": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    scheduled_time: '2023-11-07T05:31:56Z',
    run_input: {
      dynamic_variables: {},
      runtime_variables: {},
      miscellaneous: {},
      command: 'start',
      workflow_id: '5eb7cf5a86d9755df3a6c593',
      version_number: 0,
      run_by: '<string>',
      workflow_run_id: '5eb7cf5a86d9755df3a6c593',
      team_id: '<string>',
      start_node_logical_id: '<string>',
      initial_state: {},
      thread_to_node_inputs: {},
      welcome_message: '<string>'
    },
    version: 123
  })
};

fetch('https://api-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_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-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_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([
    'scheduled_time' => '2023-11-07T05:31:56Z',
    'run_input' => [
        'dynamic_variables' => [
                
        ],
        'runtime_variables' => [
                
        ],
        'miscellaneous' => [
                
        ],
        'command' => 'start',
        'workflow_id' => '5eb7cf5a86d9755df3a6c593',
        'version_number' => 0,
        'run_by' => '<string>',
        'workflow_run_id' => '5eb7cf5a86d9755df3a6c593',
        'team_id' => '<string>',
        'start_node_logical_id' => '<string>',
        'initial_state' => [
                
        ],
        'thread_to_node_inputs' => [
                
        ],
        'welcome_message' => '<string>'
    ],
    'version' => 123
  ]),
  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://api-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_id}"

	payload := strings.NewReader("{\n  \"scheduled_time\": \"2023-11-07T05:31:56Z\",\n  \"run_input\": {\n    \"dynamic_variables\": {},\n    \"runtime_variables\": {},\n    \"miscellaneous\": {},\n    \"command\": \"start\",\n    \"workflow_id\": \"5eb7cf5a86d9755df3a6c593\",\n    \"version_number\": 0,\n    \"run_by\": \"<string>\",\n    \"workflow_run_id\": \"5eb7cf5a86d9755df3a6c593\",\n    \"team_id\": \"<string>\",\n    \"start_node_logical_id\": \"<string>\",\n    \"initial_state\": {},\n    \"thread_to_node_inputs\": {},\n    \"welcome_message\": \"<string>\"\n  },\n  \"version\": 123\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scheduled_time\": \"2023-11-07T05:31:56Z\",\n  \"run_input\": {\n    \"dynamic_variables\": {},\n    \"runtime_variables\": {},\n    \"miscellaneous\": {},\n    \"command\": \"start\",\n    \"workflow_id\": \"5eb7cf5a86d9755df3a6c593\",\n    \"version_number\": 0,\n    \"run_by\": \"<string>\",\n    \"workflow_run_id\": \"5eb7cf5a86d9755df3a6c593\",\n    \"team_id\": \"<string>\",\n    \"start_node_logical_id\": \"<string>\",\n    \"initial_state\": {},\n    \"thread_to_node_inputs\": {},\n    \"welcome_message\": \"<string>\"\n  },\n  \"version\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scheduled_time\": \"2023-11-07T05:31:56Z\",\n  \"run_input\": {\n    \"dynamic_variables\": {},\n    \"runtime_variables\": {},\n    \"miscellaneous\": {},\n    \"command\": \"start\",\n    \"workflow_id\": \"5eb7cf5a86d9755df3a6c593\",\n    \"version_number\": 0,\n    \"run_by\": \"<string>\",\n    \"workflow_run_id\": \"5eb7cf5a86d9755df3a6c593\",\n    \"team_id\": \"<string>\",\n    \"start_node_logical_id\": \"<string>\",\n    \"initial_state\": {},\n    \"thread_to_node_inputs\": {},\n    \"welcome_message\": \"<string>\"\n  },\n  \"version\": 123\n}"

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

{
  "workflow_id": "5eb7cf5a86d9755df3a6c593",
  "scheduled_time": "2023-11-07T05:31:56Z",
  "team_id": "<string>",
  "created_by": "<string>",
  "updated_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "_id": "5eb7cf5a86d9755df3a6c593",
  "status": "pending",
  "run_input": {
    "dynamic_variables": {},
    "runtime_variables": {},
    "miscellaneous": {},
    "command": "start",
    "workflow_id": "<string>",
    "version_number": 0,
    "run_by": "<string>",
    "workflow_run_id": "<string>",
    "team_id": "<string>",
    "start_node_logical_id": "<string>",
    "initial_state": {},
    "thread_to_node_inputs": {},
    "welcome_message": "<string>"
  },
  "version": 123,
  "schedule_name": "<string>",
  "scheduler_arn": "<string>",
  "actual_run_id": "5eb7cf5a86d9755df3a6c593",
  "scheduled_by_name": "<string>",
  "error_message": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

PATCH

workflows

workflow-schedules

{schedule_id}

Update Workflow Schedule

curl --request PATCH \
  --url https://api-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scheduled_time": "2023-11-07T05:31:56Z",
  "run_input": {
    "dynamic_variables": {},
    "runtime_variables": {},
    "miscellaneous": {},
    "command": "start",
    "workflow_id": "5eb7cf5a86d9755df3a6c593",
    "version_number": 0,
    "run_by": "<string>",
    "workflow_run_id": "5eb7cf5a86d9755df3a6c593",
    "team_id": "<string>",
    "start_node_logical_id": "<string>",
    "initial_state": {},
    "thread_to_node_inputs": {},
    "welcome_message": "<string>"
  },
  "version": 123
}
'

import requests

url = "https://api-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_id}"

payload = {
    "scheduled_time": "2023-11-07T05:31:56Z",
    "run_input": {
        "dynamic_variables": {},
        "runtime_variables": {},
        "miscellaneous": {},
        "command": "start",
        "workflow_id": "5eb7cf5a86d9755df3a6c593",
        "version_number": 0,
        "run_by": "<string>",
        "workflow_run_id": "5eb7cf5a86d9755df3a6c593",
        "team_id": "<string>",
        "start_node_logical_id": "<string>",
        "initial_state": {},
        "thread_to_node_inputs": {},
        "welcome_message": "<string>"
    },
    "version": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    scheduled_time: '2023-11-07T05:31:56Z',
    run_input: {
      dynamic_variables: {},
      runtime_variables: {},
      miscellaneous: {},
      command: 'start',
      workflow_id: '5eb7cf5a86d9755df3a6c593',
      version_number: 0,
      run_by: '<string>',
      workflow_run_id: '5eb7cf5a86d9755df3a6c593',
      team_id: '<string>',
      start_node_logical_id: '<string>',
      initial_state: {},
      thread_to_node_inputs: {},
      welcome_message: '<string>'
    },
    version: 123
  })
};

fetch('https://api-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_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-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_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([
    'scheduled_time' => '2023-11-07T05:31:56Z',
    'run_input' => [
        'dynamic_variables' => [
                
        ],
        'runtime_variables' => [
                
        ],
        'miscellaneous' => [
                
        ],
        'command' => 'start',
        'workflow_id' => '5eb7cf5a86d9755df3a6c593',
        'version_number' => 0,
        'run_by' => '<string>',
        'workflow_run_id' => '5eb7cf5a86d9755df3a6c593',
        'team_id' => '<string>',
        'start_node_logical_id' => '<string>',
        'initial_state' => [
                
        ],
        'thread_to_node_inputs' => [
                
        ],
        'welcome_message' => '<string>'
    ],
    'version' => 123
  ]),
  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://api-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_id}"

	payload := strings.NewReader("{\n  \"scheduled_time\": \"2023-11-07T05:31:56Z\",\n  \"run_input\": {\n    \"dynamic_variables\": {},\n    \"runtime_variables\": {},\n    \"miscellaneous\": {},\n    \"command\": \"start\",\n    \"workflow_id\": \"5eb7cf5a86d9755df3a6c593\",\n    \"version_number\": 0,\n    \"run_by\": \"<string>\",\n    \"workflow_run_id\": \"5eb7cf5a86d9755df3a6c593\",\n    \"team_id\": \"<string>\",\n    \"start_node_logical_id\": \"<string>\",\n    \"initial_state\": {},\n    \"thread_to_node_inputs\": {},\n    \"welcome_message\": \"<string>\"\n  },\n  \"version\": 123\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scheduled_time\": \"2023-11-07T05:31:56Z\",\n  \"run_input\": {\n    \"dynamic_variables\": {},\n    \"runtime_variables\": {},\n    \"miscellaneous\": {},\n    \"command\": \"start\",\n    \"workflow_id\": \"5eb7cf5a86d9755df3a6c593\",\n    \"version_number\": 0,\n    \"run_by\": \"<string>\",\n    \"workflow_run_id\": \"5eb7cf5a86d9755df3a6c593\",\n    \"team_id\": \"<string>\",\n    \"start_node_logical_id\": \"<string>\",\n    \"initial_state\": {},\n    \"thread_to_node_inputs\": {},\n    \"welcome_message\": \"<string>\"\n  },\n  \"version\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-prod.interactly.ai/workflows/v1/workflow-schedules/{schedule_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scheduled_time\": \"2023-11-07T05:31:56Z\",\n  \"run_input\": {\n    \"dynamic_variables\": {},\n    \"runtime_variables\": {},\n    \"miscellaneous\": {},\n    \"command\": \"start\",\n    \"workflow_id\": \"5eb7cf5a86d9755df3a6c593\",\n    \"version_number\": 0,\n    \"run_by\": \"<string>\",\n    \"workflow_run_id\": \"5eb7cf5a86d9755df3a6c593\",\n    \"team_id\": \"<string>\",\n    \"start_node_logical_id\": \"<string>\",\n    \"initial_state\": {},\n    \"thread_to_node_inputs\": {},\n    \"welcome_message\": \"<string>\"\n  },\n  \"version\": 123\n}"

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

{
  "workflow_id": "5eb7cf5a86d9755df3a6c593",
  "scheduled_time": "2023-11-07T05:31:56Z",
  "team_id": "<string>",
  "created_by": "<string>",
  "updated_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "_id": "5eb7cf5a86d9755df3a6c593",
  "status": "pending",
  "run_input": {
    "dynamic_variables": {},
    "runtime_variables": {},
    "miscellaneous": {},
    "command": "start",
    "workflow_id": "<string>",
    "version_number": 0,
    "run_by": "<string>",
    "workflow_run_id": "<string>",
    "team_id": "<string>",
    "start_node_logical_id": "<string>",
    "initial_state": {},
    "thread_to_node_inputs": {},
    "welcome_message": "<string>"
  },
  "version": 123,
  "schedule_name": "<string>",
  "scheduler_arn": "<string>",
  "actual_run_id": "5eb7cf5a86d9755df3a6c593",
  "scheduled_by_name": "<string>",
  "error_message": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

schedule_id

string

required

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

Body

application/json

scheduled_time

string<date-time> | null

New scheduled time in UTC

run_input

WorkflowRunInput · object | null

Input to the workflow, used to kick off or resume a workflow run.

Show child attributes

version

integer | null

Response

Successful Response

Stores scheduled workflow runs.

workflow_id

string

required

ID of the workflow to run

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

scheduled_time

string<date-time>

required

The target time for the workflow execution (UTC)

team_id

string | null

ID of the team that owns this edge

created_by

string | null

ID of the user who created this edge

updated_by

string | null

ID of the user who last updated this edge

created_at

string<date-time>

updated_at

string<date-time>

_id

string | null

MongoDB document ObjectID

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

status

enum<string>

default:pending

Current status of the schedule

Available options:

pending,

in_progress,

completed,

failed,

cancelled

run_input

WorkflowRunInput · object

Inputs and dynamic variables for the workflow run

Show child attributes

version

integer | null

Version of the workflow to run

schedule_name

string | null

AWS EventBridge Schedule name (used for deletion)

scheduler_arn

string | null

AWS EventBridge Scheduler ARN

actual_run_id

string | null

Link to the actual WorkflowRunsModel ID once executed

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

scheduled_by_name

string | null

Display name of the user who created the schedule

error_message

string | null

Error message if the schedule failed to execute

Cancel Workflow Schedule Get Node Library Schema

Getting Started

APIs

Campaigns

Workflows

SMS

Update Workflow Schedule

Authorizations

Path Parameters

Body

Response