Workspaces

Um workspace é o tenant ao qual uma inbox pertence. Veja o modelo Workspace para o formato do objeto retornado.

Comando	HTTP	Descrição
workspaces list	GET /workspaces	Lista os workspaces da sua organização. Paginado por cursor.
workspaces get	GET /workspaces/{id}	Busca um workspace por id interno ou external_id.
workspaces create	POST /workspaces	Cria um workspace. Requer um token src=system.
workspaces upsert	PUT /workspaces	Cria ou atualiza, casado por id e depois external_id.
workspaces update	PATCH /workspaces/{id}	Atualiza no local.
workspaces delete	DELETE /workspaces/{id}	Soft-delete.

Exemplos

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

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

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

# Criar ou atualizar, casado por external_id
kobana inbox workspaces upsert \
  --json '{"external_id": "acme-42", "label": "Acme Inc.", "monthly_cost_limit": 100}'

# Atualizar um limite
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 passos

• Inboxes — os endereços de recebimento que pertencem a um workspace.
• Introspecção de schema — todos os parâmetros que este recurso aceita.