Actualizar un agente

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

Al activar una tarea (is_paused: false), Nexor empieza a contactar a todos los leads que esperan en ella, según su cadencia. Las llamadas esperan el horario de contacto de la tarea; los mensajes salen de inmediato salvo que la tarea los restrinja a su horario. No se contacta a los leads marcados como no contactar, y las tareas solo entrantes no inician contacto. Revisa cuántos leads hay en espera antes de activarla.

PATCH /workflows/:id Renombra un agente, edita su descripción, actívalo/pausalo, o déjalo en modo solo responde. Los agentes nacen pausados al crearse vía API — esta es la única forma de encenderlos programáticamente.

Parámetros de Ruta

Parámetro	Tipo	Requerido	Descripción
`id`	string (uuid)	Sí	ID del agente

Cuerpo de la Solicitud

Provee al menos uno de los siguientes.

Campo	Tipo	Requerido	Descripción
`is_paused`	boolean	No	`false` activa el agente, `true` lo pausa
`inbound_only`	boolean	No	Interruptor “solo responde”. `true`: el agente nunca escribe primero. Al inscribir o traspasar un lead no se agenda ningún primer contacto ni cadencia; el agente solo contesta cuando el lead escribe. `false`: comportamiento normal de salida. La respuesta devuelve el valor que quedó guardado.
`name`	string	No	Nuevo nombre del agente
`description`	string	No	Nueva descripción del agente

Respuestas

`200` — Actualizado

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

pending_runs solo aparece al activar, y refleja los leads cuya cadencia se reanuda de inmediato.

`400` — Error de validación

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

`400` — Activación bloqueada

Los agentes con goal_type: appointment necesitan al menos un tipo de reunión activo antes de poder activarse:

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

`401` — Error de autenticación

Ver Autenticación.

`404` — No encontrado

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

`500` — Error interno del servidor

Autorizaciones

X-API-Key

string

header

requerido

API key for authentication. Keys are prefixed with nxr_live_.

Parámetros de ruta

string<uuid>

requerido

Workflow identifier.

Cuerpo

application/json

is_paused

boolean

requerido

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>

Opciones disponibles:

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>

Opciones disponibles:

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.

Respuesta

Successful response.

success

enum<boolean>

requerido

Opciones disponibles:

true

workflow_id

string<uuid>

requerido

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.

Última modificación el 6 de octubre de 2026

Empieza aquí

Quickstart

Referencia API

Configura y lanza

WhatsApp

Canales

Agentes

Reuniones

Integraciones

Cuenta

Bandeja de entrada

Métricas

Herramientas para desarrolladores

Referencia de soporte

Actualizar un agente

Parámetros de Ruta

Cuerpo de la Solicitud

Respuestas

`200` — Actualizado

`400` — Error de validación

`400` — Activación bloqueada

`401` — Error de autenticación

`404` — No encontrado

`500` — Error interno del servidor

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta

​Parámetros de Ruta

​Cuerpo de la Solicitud

​Respuestas

​200 — Actualizado

​400 — Error de validación

​400 — Activación bloqueada

​401 — Error de autenticación

​404 — No encontrado

​500 — Error interno del servidor

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta

Parámetros de Ruta

Cuerpo de la Solicitud

Respuestas

`200` — Actualizado

`400` — Error de validación

`400` — Activación bloqueada

`401` — Error de autenticación

`404` — No encontrado

`500` — Error interno del servidor