Update an Agent

curl --request PATCH \
  --url https://api.getnexor.ai/api/public/workflows/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "is_paused": true,
  "name": "<string>",
  "description": "<string>",
  "goal_statement": "<string>",
  "begin_message": "<string>",
  "master_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timezone": "<string>",
  "agent_name": "<string>",
  "agent_role": "<string>",
  "company_name": "<string>",
  "inbound_only": true
}
'

import requests

url = "https://api.getnexor.ai/api/public/workflows/{id}"

payload = {
    "is_paused": True,
    "name": "<string>",
    "description": "<string>",
    "goal_statement": "<string>",
    "begin_message": "<string>",
    "master_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timezone": "<string>",
    "agent_name": "<string>",
    "agent_role": "<string>",
    "company_name": "<string>",
    "inbound_only": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_paused: true,
    name: '<string>',
    description: '<string>',
    goal_statement: '<string>',
    begin_message: '<string>',
    master_workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    timezone: '<string>',
    agent_name: '<string>',
    agent_role: '<string>',
    company_name: '<string>',
    inbound_only: true
  })
};

fetch('https://api.getnexor.ai/api/public/workflows/{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.getnexor.ai/api/public/workflows/{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([
    'is_paused' => true,
    'name' => '<string>',
    'description' => '<string>',
    'goal_statement' => '<string>',
    'begin_message' => '<string>',
    'master_workflow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'timezone' => '<string>',
    'agent_name' => '<string>',
    'agent_role' => '<string>',
    'company_name' => '<string>',
    'inbound_only' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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.getnexor.ai/api/public/workflows/{id}"

	payload := strings.NewReader("{\n  \"is_paused\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goal_statement\": \"<string>\",\n  \"begin_message\": \"<string>\",\n  \"master_workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"timezone\": \"<string>\",\n  \"agent_name\": \"<string>\",\n  \"agent_role\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"inbound_only\": true\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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.getnexor.ai/api/public/workflows/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_paused\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goal_statement\": \"<string>\",\n  \"begin_message\": \"<string>\",\n  \"master_workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"timezone\": \"<string>\",\n  \"agent_name\": \"<string>\",\n  \"agent_role\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"inbound_only\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getnexor.ai/api/public/workflows/{id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_paused\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goal_statement\": \"<string>\",\n  \"begin_message\": \"<string>\",\n  \"master_workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"timezone\": \"<string>\",\n  \"agent_name\": \"<string>\",\n  \"agent_role\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"inbound_only\": true\n}"

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

{
  "success": true,
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "language": "<string>",
  "timezone": "<string>",
  "region_style": "<string>",
  "agent_name": "<string>",
  "agent_role": "<string>",
  "company_name": "<string>",
  "master_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pending_runs": 123,
  "activation_warnings": [
    {}
  ],
  "blockers": [
    {}
  ],
  "is_paused": true,
  "identity": {},
  "inbound_only": true
}

{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>"
}

PATCH

workflows

{id}

Update an Agent

curl --request PATCH \
  --url https://api.getnexor.ai/api/public/workflows/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "is_paused": true,
  "name": "<string>",
  "description": "<string>",
  "goal_statement": "<string>",
  "begin_message": "<string>",
  "master_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timezone": "<string>",
  "agent_name": "<string>",
  "agent_role": "<string>",
  "company_name": "<string>",
  "inbound_only": true
}
'

import requests

url = "https://api.getnexor.ai/api/public/workflows/{id}"

payload = {
    "is_paused": True,
    "name": "<string>",
    "description": "<string>",
    "goal_statement": "<string>",
    "begin_message": "<string>",
    "master_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timezone": "<string>",
    "agent_name": "<string>",
    "agent_role": "<string>",
    "company_name": "<string>",
    "inbound_only": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_paused: true,
    name: '<string>',
    description: '<string>',
    goal_statement: '<string>',
    begin_message: '<string>',
    master_workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    timezone: '<string>',
    agent_name: '<string>',
    agent_role: '<string>',
    company_name: '<string>',
    inbound_only: true
  })
};

fetch('https://api.getnexor.ai/api/public/workflows/{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.getnexor.ai/api/public/workflows/{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([
    'is_paused' => true,
    'name' => '<string>',
    'description' => '<string>',
    'goal_statement' => '<string>',
    'begin_message' => '<string>',
    'master_workflow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'timezone' => '<string>',
    'agent_name' => '<string>',
    'agent_role' => '<string>',
    'company_name' => '<string>',
    'inbound_only' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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.getnexor.ai/api/public/workflows/{id}"

	payload := strings.NewReader("{\n  \"is_paused\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goal_statement\": \"<string>\",\n  \"begin_message\": \"<string>\",\n  \"master_workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"timezone\": \"<string>\",\n  \"agent_name\": \"<string>\",\n  \"agent_role\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"inbound_only\": true\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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.getnexor.ai/api/public/workflows/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_paused\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goal_statement\": \"<string>\",\n  \"begin_message\": \"<string>\",\n  \"master_workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"timezone\": \"<string>\",\n  \"agent_name\": \"<string>\",\n  \"agent_role\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"inbound_only\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getnexor.ai/api/public/workflows/{id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_paused\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goal_statement\": \"<string>\",\n  \"begin_message\": \"<string>\",\n  \"master_workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"timezone\": \"<string>\",\n  \"agent_name\": \"<string>\",\n  \"agent_role\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"inbound_only\": true\n}"

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

{
  "success": true,
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "language": "<string>",
  "timezone": "<string>",
  "region_style": "<string>",
  "agent_name": "<string>",
  "agent_role": "<string>",
  "company_name": "<string>",
  "master_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pending_runs": 123,
  "activation_warnings": [
    {}
  ],
  "blockers": [
    {}
  ],
  "is_paused": true,
  "identity": {},
  "inbound_only": true
}

{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>"
}

Activating a task (is_paused: false) starts contacting every lead waiting in it, per its cadence. Calls wait for the task’s contact hours; messages go right away unless the task restricts messages to its hours. Do-not-contact leads are not contacted, and inbound-only tasks don’t start outreach. Check how many leads are waiting before you turn it on.

PATCH /workflows/:id Rename an agent, edit its description, activate/pause it, or make it reply-only. Agents are born paused when created via the API — this is the only way to turn one on programmatically.

Path Parameters

Parameter	Type	Required	Description
`id`	string (uuid)	Yes	Agent ID

Request Body

Provide at least one of the following.

Field	Type	Required	Description
`is_paused`	boolean	No	`false` activates the agent, `true` pauses it
`name`	string	No	New agent name
`description`	string	No	New agent description
`inbound_only`	boolean	No	Reply-only switch. `true`: the agent never writes first. Enrolling or transferring a lead into it schedules no first contact and no cadence; the agent only answers when the lead writes. `false`: normal outbound behavior. The response echoes the value that was stored.

Responses

`200` — Updated

{
  "success": true,
  "workflow_id": "123e4567-e89b-12d3-a456-426614174000",
  "is_paused": false,
  "pending_runs": 3
}

pending_runs is only present when activating, and reflects leads whose cadence resumes immediately.

`400` — Validation error

{
  "error": "Invalid input",
  "message": "Provide is_paused, name or description"
}

`400` — Activation blocked

Appointment-goal agents need at least one active meeting type before they can be activated:

{
  "error": "Activation blocked",
  "message": "Configure at least one active meeting type before activating this workflow."
}

`401` — Authentication error

See Authentication.

`404` — Not found

{
  "error": "Not found",
  "message": "Workflow not found"
}

`500` — Internal server error

Authorizations

X-API-Key

string

header

required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

string<uuid>

required

Workflow identifier.

Body

application/json

is_paused

boolean

required

name

string

description

string

goal_statement

string

Maximum string length: 800

begin_message

string

Maximum string length: 1000

master_workflow_id

string<uuid> | null

language

enum<string>

Available options:

es-CL,

es-MX,

es-PE,

es-CO,

es-US,

en-US,

en-AU,

ko-KR,

pt-BR,

fr-FR

timezone

string

Valid IANA time-zone name.

region_style

enum<string>

Available options:

cl,

mx,

pe,

co,

ar,

es,

latam,

us,

au,

gb,

in,

nz,

kr,

br,

pt,

agent_name

string

Maximum string length: 200

agent_role

string

Maximum string length: 200

company_name

string

Maximum string length: 200

inbound_only

boolean

Reply-only switch. true: the agent never initiates contact (no first contact and no cadence when a lead enrols or is transferred in) and only answers when the lead writes. false: normal outbound behavior.

Response

Successful response.

success

enum<boolean>

required

Available options:

true

workflow_id

string<uuid>

required

language

string

timezone

string

region_style

string | null

agent_name

string

agent_role

string

company_name

string

master_workflow_id

string<uuid> | null

pending_runs

integer

activation_warnings

object[]

blockers

object[]

is_paused

boolean

identity

object

inbound_only

boolean

Persisted value of the reply-only switch, read back from the stored agent.

Last modified on October 6, 2026

Start here

Quickstart

API reference

Build and launch

WhatsApp

Channels

Agents

Meetings

Integrations

Account

Inbox

Insights

Developer tools

Support reference

Update an Agent

Path Parameters

Request Body

Responses

`200` — Updated

`400` — Validation error

`400` — Activation blocked

`401` — Authentication error

`404` — Not found

`500` — Internal server error

Authorizations

Path Parameters

Body

Response

​Path Parameters

​Request Body

​Responses

​200 — Updated

​400 — Validation error

​400 — Activation blocked

​401 — Authentication error

​404 — Not found

​500 — Internal server error

Authorizations

Path Parameters

Body

Response

Path Parameters

Request Body

Responses

`200` — Updated

`400` — Validation error

`400` — Activation blocked

`401` — Authentication error

`404` — Not found

`500` — Internal server error