Saltar al contenido principal

Workspaces

Un workspace es el tenant al que pertenece un inbox. Ver el modelo Workspace para la forma del objeto devuelto.

ComandoHTTPDescripción
workspaces listGET /workspacesLista los workspaces de tu organización. Paginado por cursor.
workspaces getGET /workspaces/{id}Obtiene un workspace por id interno o external_id.
workspaces createPOST /workspacesCrea un workspace. Requiere un token src=system.
workspaces upsertPUT /workspacesCrea o actualiza, emparejado por id y luego external_id.
workspaces updatePATCH /workspaces/{id}Actualiza en el lugar.
workspaces deleteDELETE /workspaces/{id}Soft-delete.

Ejemplos​

# Listar, filtrado y con máscara de campos
kobana inbox workspaces list \
--params '{"source": "kobana_app", "limit": 25}' \
--fields "id,label,slug,source"

# Obtener uno
kobana inbox workspaces get \
--params '{"id": "WORKSPACE_ID"}' \
--fields "id,label,monthly_cost_limit,monthly_emails_limit"

# Crear
kobana inbox workspaces create \
--json '{"label": "Acme Inc.", "source": "kobana_app", "slug": "acme"}'

# Crear o actualizar, emparejado por external_id
kobana inbox workspaces upsert \
--json '{"external_id": "acme-42", "label": "Acme Inc.", "monthly_cost_limit": 100}'

# Actualizar un límite
kobana inbox workspaces update \
--params '{"id": "WORKSPACE_ID"}' \
--json '{"monthly_emails_limit": 5000}'

# Soft-delete
kobana inbox workspaces delete --params '{"id": "WORKSPACE_ID"}' --dry-run

Próximos pasos​