Editar função

PATCH /chatbot/functions

Altera só os campos enviados. A função é validada de novo; se houver problems, fica desativada.

Autenticação

[
  {
    "token": []
  }
]

{
  "token": {
    "name": "token",
    "type": "apiKey",
    "in": "header"
  }
}

Corpo da requisição

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AIFunctionInput"
      },
      "example": {
        "function_id": "rfn1a2b3c4d5e6f",
        "active": false
      }
    }
  }
}

Respostas

{
  "200": {
    "description": "Função atualizada",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AIFunction"
        },
        "example": {
          "id": "rf1b2c3d4e5f6a7",
          "name": "consultar_pedido",
          "description": "Consulta o status de um pedido pelo número.",
          "active": true,
          "method": "GET",
          "url": "https://loja.com/api/pedidos/{{numero}}",
          "headers": {
            "Authorization": "Bearer {{segredo}}"
          },
          "body": "",
          "parameters": [
            {
              "name": "numero",
              "type": "string",
              "description": "Número do pedido.",
              "required": true
            }
          ],
          "problems": {
            "invalid_headers": false,
            "invalid_body": false,
            "undocumented_parameters": []
          },
          "created_at": "2026-10-17T12:00:00.000Z",
          "updated_at": "2026-10-17T12:00:00.000Z"
        }
      }
    }
  },
  "400": {
    "description": "`invalid_request`: JSON malformado ou campo desconhecido; ou `name` fora do padrão, repetido ou de uma ferramenta da IA; `url` sem `http://` ou `https://`; campo obrigatório esvaziado; ou valor de `enum` com vírgula.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "invalid_request",
          "message": "JSON malformado ou campo desconhecido."
        }
      }
    }
  },
  "401": {
    "description": "Token ausente ou inválido.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unauthorized",
          "message": "Token inválido."
        }
      }
    }
  },
  "404": {
    "description": "Nenhum recurso com esse `id` nesta inbox.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "not_found",
          "message": "Nenhum recurso com esse `id` nesta inbox."
        }
      }
    }
  },
  "409": {
    "description": "A inbox ainda não foi conectada ao WhatsApp. Os dados pertencem ao número conectado; conecte a inbox antes (`inbox_not_paired`).",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "inbox_not_paired",
          "message": "A inbox ainda não foi conectada ao WhatsApp. Os dados pertencem ao número conectado; conecte a inbox antes (`inbox_not_paired`)."
        }
      }
    }
  },
  "429": {
    "$ref": "#/components/responses/RateLimited"
  },
  "500": {
    "description": "Falha inesperada ao gravar ou ler os dados.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "internal_error",
          "message": "Erro interno; tente de novo."
        }
      }
    }
  }
}

Estado: Disponível

Compatibilidade de canais

CanalCompatívelObservação
WhatsApp (Web)Sim
WhatsApp (API oficial)Sim
InstagramSim
MessengerSim
TelegramSim

Eventos que esta rota gera

Nenhum. Esta rota não gera evento no webhook (nem em GET /events): o resultado vem só na resposta.

Antes e depois (uazapi → Orkesio)

Na uazapi: PATCH /chatbot/functions/{id}.

  • Mesmas funções; o id vai no corpo, em function_id (antes {id} no caminho); muda o formato: campos em snake_case, datas em ISO 8601 (_at) e erros em {error, message}.
  • Campos renomeados: createdAt → created_at, invalidBody → invalid_body, invalidHeaders → invalid_headers, undocumentedParameters → undocumented_parameters, updatedAt → updated_at.

#/components/schemas/AIFunctionInput

{
  "type": "object",
  "description": "Na criação, `name`, `method` e `url` são obrigatórios. Na edição, só os campos enviados mudam.",
  "additionalProperties": false,
  "properties": {
    "function_id": {
      "type": "string",
      "description": "ID da função."
    },
    "name": {
      "type": "string",
      "description": "Nome da função para o modelo, como `consultar_pedido`: começa com letra ou `_`, só letras, números, `_` e `-`, até 64 caracteres. Não pode repetir o de outra função nem ser o de uma ferramenta da IA (`chamar_humano`, `atualizar_lead`, `enviar_mensagem_cadastrada`, `enviar_menu`): o provedor recusaria todo pedido e a IA ficaria calada.",
      "pattern": "^[A-Za-z_][A-Za-z0-9_-]{0,63}
quot;
    },
    "description": {
      "type": "string",
      "description": "Quando o modelo deve usar a função. É o que ele lê para decidir."
    },
    "active": {
      "type": "boolean",
      "description": "Padrão `true`. Funções com `problems` são salvas desativadas."
    },
    "method": {
      "type": "string",
      "enum": [
        "GET",
        "POST",
        "PUT",
        "PATCH",
        "DELETE"
      ],
      "description": "Método HTTP da chamada. No teste do agente (`POST /chatbot/agents/reply`), só `GET` roda de verdade."
    },
    "url": {
      "type": "string",
      "description": "Endereço público chamado. Aceita placeholders `{{parametro}}` e `{{NOW}}` (data e hora atuais)."
    },
    "headers": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Headers enviados; aceitam placeholders."
    },
    "body": {
      "type": "string",
      "description": "Modelo JSON do body (POST, PUT, PATCH), com placeholders. Vazio envia os argumentos do modelo como JSON."
    },
    "parameters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AIFunctionParameter"
      },
      "description": "O que o modelo preenche ao chamar a função. Cada `name` vira o placeholder `{{name}}`."
    }
  },
  "required": [
    "function_id"
  ]
}

#/components/schemas/AIFunctionParameter

{
  "type": "object",
  "required": [
    "name",
    "type",
    "description"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Nome usado nos placeholders `{{parametro}}` da URL, dos headers e do body."
    },
    "type": {
      "type": "string",
      "enum": [
        "string",
        "number",
        "integer",
        "boolean"
      ],
      "description": "Tipo do valor que o modelo preenche."
    },
    "description": {
      "type": "string",
      "description": "Explica ao modelo o que preencher."
    },
    "required": {
      "type": "boolean",
      "description": "Se o modelo é obrigado a preencher. Padrão `false`."
    },
    "enum": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Valores aceitos (sem vírgula)."
    },
    "minimum": {
      "type": "number",
      "description": "Menor valor aceito, para `number` e `integer`."
    },
    "maximum": {
      "type": "number",
      "description": "Maior valor aceito, para `number` e `integer`."
    }
  }
}

#/components/schemas/AIFunction

{
  "type": "object",
  "description": "Chamada HTTP que o agente pode fazer durante a conversa para buscar ou registrar dados no seu sistema (consultar pedido, agendar, criar lead).",
  "required": [
    "id",
    "name",
    "description",
    "active",
    "method",
    "url",
    "headers",
    "body",
    "parameters",
    "problems",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "ID da função, usado em `/chatbot/functions/{function_id}`."
    },
    "name": {
      "type": "string",
      "description": "Nome da função para o modelo, como `consultar_pedido`."
    },
    "description": {
      "type": "string",
      "description": "Quando o modelo deve usar a função. É o que ele lê para decidir."
    },
    "active": {
      "type": "boolean",
      "description": "Se os agentes podem usar a função. Função com `problems` fica `false` até ser corrigida."
    },
    "method": {
      "type": "string",
      "enum": [
        "GET",
        "POST",
        "PUT",
        "PATCH",
        "DELETE"
      ],
      "description": "Método HTTP da chamada. No teste do agente (`POST /chatbot/agents/reply`), só `GET` roda de verdade."
    },
    "url": {
      "type": "string",
      "description": "Endereço público chamado. Aceita placeholders `{{parametro}}` e `{{NOW}}` (data e hora atuais)."
    },
    "headers": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Headers enviados; aceitam placeholders."
    },
    "body": {
      "type": "string",
      "description": "Modelo JSON do body (POST, PUT, PATCH), com placeholders. Vazio envia os argumentos do modelo como JSON."
    },
    "parameters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AIFunctionParameter"
      },
      "description": "O que o modelo preenche ao chamar a função. Cada `name` vira o placeholder `{{name}}`."
    },
    "problems": {
      "type": "object",
      "readOnly": true,
      "description": "O que impede a função de ser usada. Com algum problema, a função fica desativada até ser corrigida.",
      "required": [
        "invalid_headers",
        "invalid_body",
        "undocumented_parameters"
      ],
      "properties": {
        "invalid_headers": {
          "type": "boolean",
          "description": "`true` quando os headers não formam um JSON válido (com os placeholders)."
        },
        "invalid_body": {
          "type": "boolean",
          "description": "`true` quando o `body` não é um JSON válido (com os placeholders)."
        },
        "undocumented_parameters": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Placeholders usados sem parâmetro com o mesmo nome."
        }
      }
    },
    "created_at": {
      "description": "Criação. ISO 8601 em UTC com milissegundos.",
      "readOnly": true,
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "description": "Última alteração. ISO 8601 em UTC com milissegundos.",
      "readOnly": true,
      "type": "string",
      "format": "date-time"
    }
  }
}

#/components/schemas/OrkesioError

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
    },
    "message": {
      "type": "string",
      "description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
    },
    "field": {
      "type": "string",
      "description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
    }
  },
  "required": [
    "error",
    "message"
  ],
  "additionalProperties": true,
  "description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}

#/components/responses/RateLimited

{
  "description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
  "headers": {
    "Retry-After": {
      "description": "Segundos até poder chamar de novo.",
      "schema": {
        "type": "integer",
        "minimum": 1
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "rate_limited",
        "message": "Muitas requisições."
      }
    }
  }
}

Guias relacionados

Visão geral · O que funciona em cada canal · O que muda da uazapi