API · automations

GET /automations

Listar automatizaciones del workspace actual

• Autenticação: Chave de API ou sessão do painel
• Escopos: Nenhum

Respostas

POST /automations

Crear una automatización

F3-184: los avisos al cliente al entrar en una etapa (workitem.stage_entered) y el de confirmación (booking.confirmed) no son reglas: se configuran como on_enter.notify_customer (con enabled) en las etapas del servicio (PUT /services/{id}/stages). Crear una regla al cliente con esos disparadores responde 422; para demoras o condiciones se usa un flujo sobre workitem.stage_entered.

• Autenticação: Chave de API ou sessão do painel
• Escopos: Nenhum

Corpo da solicitação (obrigatório)

• application/json: AutomationCreate

Respostas

PATCH /automations/{id}

Editar o apagar una automatización y regenerar sus jobs abiertos

• Autenticação: Chave de API ou sessão do painel
• Escopos: Nenhum

Parâmetros

Corpo da solicitação (obrigatório)

• application/json: AutomationPatch

Respostas

GET /automations/customer-notices/deliveries

Customer Notice Deliveries

Owner/manager; tenant desde credencial. Bitácora de intentos, sin texto ni datos del canal. Retención 90 días. Políticas por servicio inicialmente apagadas; cambios auditados. PUT exige CSRF para sesión.

• Autenticação: Chave de API ou sessão do painel
• Escopos: config:read

Parâmetros

Respostas

GET /automations/customer-notices/policies

Customer Notice Policies

Owner/manager; tenant desde credencial. Bitácora de intentos, sin texto ni datos del canal. Retención 90 días. Políticas por servicio inicialmente apagadas; cambios auditados. PUT exige CSRF para sesión.

• Autenticação: Chave de API ou sessão do painel
• Escopos: config:read

Respostas

PUT /automations/customer-notices/policies

Customer Notice Policy Save

Owner/manager; tenant desde credencial. Bitácora de intentos, sin texto ni datos del canal. Retención 90 días. Políticas por servicio inicialmente apagadas; cambios auditados. PUT exige CSRF para sesión.

• Autenticação: Chave de API ou sessão do painel
• Escopos: config:write

Corpo da solicitação (obrigatório)

• application/json: CustomerNoticePolicyIn

Respostas

POST /automations/customer-notices/preview

Customer Notice Previews

Owner/manager + CSRF; tenant desde sesión. Solo lectura, sin enviar ni guardar: texto real de plantilla con datos de ejemplo, vocabulario/idioma del borrador, canal disponible. Los textos de flujos muestran sus bindings sin resolver.

• Autenticação: Chave de API ou sessão do painel
• Escopos: config:write

Corpo da solicitação (obrigatório)

• application/json: CustomerNoticePreviewIn

Respostas

GET /automations/recommended

Automatizaciones recomendadas por rasgos del proyecto

Unión sin duplicados de los ejemplos parecidos (F3-409), con su estado real y una vista previa en el idioma del proyecto, con datos de muestra. Sin rasgos también ofrece recomendaciones generales. El alias de transición blueprint identifica el ejemplo más parecido o es nulo. Instalar siempre crea inactivas y conserva las ediciones existentes. Owner/manager.

• Autenticação: Chave de API ou sessão do painel
• Escopos: Nenhum

Respostas

PUT /automations/recommended/{key}/activation

Activar o pausar una recomendada

La instala antes si el proyecto todavía no la tiene. Idempotente. Activar una regla no reprograma el pasado. 404 recommended_automation_not_found si la clave no es del blueprint. Owner/manager.

• Autenticação: Chave de API ou sessão do painel
• Escopos: Nenhum

Parâmetros

Corpo da solicitação (obrigatório)

• application/json: RecommendedActivation

Respostas

POST /automations/recommended/install

Instalar las recomendadas que falten (inactivas)

Idempotente; no duplica ni pisa lo que el negocio editó. installed cuenta las creadas por esta llamada. Los proyectos nuevos ya las traen instaladas e inactivas. Owner/manager.

• Autenticação: Chave de API ou sessão do painel
• Escopos: Nenhum

Respostas

GET /automations/stage-options

Etapas y acciones válidas para las reglas por etapa

Claves y etiquetas pt/es/en del blueprint vigente del workspace (vacío si no tiene). Son los valores admitidos por stage y action_key.

• Autenticação: Chave de API ou sessão do painel
• Escopos: Nenhum

Respostas

GET /notices/overview

Notices Overview

Todo lo que sale al cliente (reglas, política por servicio, etapas y flujos), ordenado en el tiempo del servicio. Cada fila trae su valor efectivo, el motivo si está frenada y dónde se edita. Solo lectura. Dueño o encargado; tenant desde credencial.

• Autenticação: Chave de API ou sessão do painel
• Escopos: config:read

Parâmetros

Respostas

PATCH /notices/overview

Notices Master

«Apagar todos los avisos a clientes»: el único interruptor del proyecto; gana sobre el de cada fila. Dueño o encargado; tenant desde credencial. Exige CSRF para sesión. Escribe en la fuente de cada aviso, con su validación y auditoría.

• Autenticação: Chave de API ou sessão do painel
• Escopos: config:write

Corpo da solicitação (obrigatório)

• application/json: NoticeMasterPatch

Respostas

PATCH /notices/overview/{item_id}

Notices Item

Enciende o apaga una fila: escribe en su fuente (regla, política, etapa o flujo) con su validación. Dueño o encargado; tenant desde credencial. Exige CSRF para sesión. Escribe en la fuente de cada aviso, con su validación y auditoría. Las filas stage publican el flujo y requieren además flows:write (solo dueño) o settings:write junto con config:write para API key. Sin el permiso de origen responde 403; la lectura devuelve toggleable=false para esa fila.

• Autenticação: Chave de API ou sessão do painel
• Escopos: config:write, flows:write, settings:write

Parâmetros

Corpo da solicitação (obrigatório)

• application/json: NoticeItemPatch

Respostas