Llamar a cualquier endpoint

Llamar a cualquier endpoint

Envía un request autenticado a cualquier endpoint de la API de Plazbot, aunque no tenga un comando propio en el CLI. Es el equivalente a stripe get o az rest: el CLI agrega el token, el workspace y la zona por ti, y siempre imprime la respuesta como JSON.

01plazbot api <método> <ruta> [opciones]

El método es get, post, put, patch o delete. La ruta es solo el path (/api/contact); si no empieza con /api/, el CLI lo agrega. No se aceptan URLs completas: para cambiar de región usa -z.

Parámetros

Qué agrega el CLI

• Authorization: Bearer <token> y x-workspace-id con el workspace de la sesión (o el de -w).
• ?workspaceId=<workspace> en la query, salvo que ya lo pases con -q o uses --no-workspace-param.
• {ws} en la ruta, en los valores de -q y en el body se reemplaza por el ID del workspace.

Confirmación y endpoints peligrosos

• GET se ejecuta directo.
• POST, PUT, PATCH y DELETE piden confirmación. Sin terminal interactiva (scripts, CI, agentes de IA) fallan con confirmation_required hasta que agregues --yes.
• Algunos endpoints siempre exigen --yes, aunque estés en una terminal, porque borran o envían en masa:

Ejemplos

01# Configuración del workspace (etiquetas, fases, pipelines, canales...)
02plazbot api get /api/workspace/{ws}
03 
04# Miembros del equipo
05plazbot api get /api/workspace/usersByWorkspaceId/{ws}
06 
07# Reporte de mensajes de una semana, en otro workspace de Europa
08plazbot api get /api/report/message -q startDate=2026-10-01 -q endDate=2026-10-07 -w wok_AbcDef123 -z EU
09 
10# Crear una etiqueta (sin preguntar)
11plazbot api post /api/workspace/{ws}/masterOfTags -d '{"name":"VIP","color":"#22c55e"}' --yes
12 
13# Body desde un archivo
14plazbot api put /api/workspace/{ws}/view/viw_AbcDef123 -d @vista.json --yes
15 
16# Body desde stdin
17cat cambios.json | plazbot api put /api/contact -q id=con_AbcDef123 -d - --yes
18 
19# Ver el código HTTP
20plazbot api get /api/sequence -i

Endpoints útiles de lectura

Para lo más común hay comandos propios con tabla y paginación: contacts, messages, campaigns, reports y el resto que lista plazbot commands.

Resultado

La respuesta de la API se imprime tal cual en stdout, formateada como JSON. Si no es JSON (por ejemplo, la descarga de un archivo), se imprime como texto.

01{
02  "success": true,
03  "code": 200,
04  "errorCode": null,
05  "message": "List obtained successfully.",
06  "data": {
07    "workspaceId": "wok_AbcDef123",
08    "continuationToken": null,
09    "data": []
10  }
11}

Con -i el código HTTP sale en stderr (HTTP 200 OK), así no ensucia el JSON.

Errores comunes

El comando termina con código 1 cuando la API responde HTTP 400 o más, o cuando la respuesta trae "success": false (muchos endpoints de Plazbot responden 200 aunque fallen). El body de la respuesta se imprime igual en stdout y el error va a stderr:

01{"error":{"message":"One or more validation errors occurred. currentUser: The currentUser field is required.","code":"request_failed","status":400}}