Recursos
Workspaces
O workspace é a conta da empresa: conversas, leads, campanhas, automações e saldo pertencem a um workspace, e uma pessoa pode participar de vários. Este grupo lista e cria workspaces e gerencia membros, convites, cargos personalizados, permissões, atribuições de recursos a membros e as configurações gerais (roleta de distribuição, fila de atendimento, encerramento automático e proteção contra spam). Aqui o workspace vai no caminho ({workspaceId}); nos demais grupos ele vem do cabeçalho X-Workspace-ID. GET /workspaces/permissions traz o catálogo de recursos e ações que formam as permissões exigidas pelas demais rotas.
Rotas 40
- GETListar membros
/v1/workspaces/{workspaceId}/members - GETConsultar membro
/v1/workspaces/{workspaceId}/members/{userId} - GETPolítica de segurança do workspace
/workspace/security - GETLogin único do workspace
/workspace/sso - GETListar workspaces
/workspaces - GETListar meus convites
/workspaces/invites - GETListar permissões disponíveis
/workspaces/permissions - GETConsultar workspace
/workspaces/{workspaceId} - GETListar atribuições de recurso
/workspaces/{workspaceId}/assignments/{resourceType}/{resourceId} - GETObter configuração do workspace
/workspaces/{workspaceId}/config - GETListar convites do workspace
/workspaces/{workspaceId}/invites - GETListar membros atribuíveis
/workspaces/{workspaceId}/members/assignable - GETConsultar permissões do membro
/workspaces/{workspaceId}/members/{userId}/permissions - GETListar cargos personalizados
/workspaces/{workspaceId}/roles - GETObter a assinatura do workspace
/workspaces/{workspaceId}/subscription - POSTAdicionar um domínio ao login único
/workspace/sso/domains - POSTVerificar um domínio
/workspace/sso/domains/{domainId}/verify - POSTCriar workspace
/workspaces - POSTAceitar convite
/workspaces/invites/accept - POSTRecusar convite
/workspaces/invites/{inviteId}/decline - POSTAtribuir recurso a um membro
/workspaces/{workspaceId}/assignments - POSTConvidar membro
/workspaces/{workspaceId}/members/invite - POSTCriar cargo personalizado
/workspaces/{workspaceId}/roles - POSTGerar a fatura para assinar um plano
/workspaces/{workspaceId}/subscription - POSTCancelar a assinatura do workspace
/workspaces/{workspaceId}/subscription/cancel - PUTSalvar a conexão de login único
/workspace/sso/connection - PUTAtualizar workspace
/workspaces/{workspaceId} - PUTAtualizar configuração do workspace
/workspaces/{workspaceId}/config - PUTAtribuir cargo personalizado a um membro
/workspaces/{workspaceId}/members/{userId}/assign-role - PUTDefinir permissões do membro
/workspaces/{workspaceId}/members/{userId}/permissions - PUTAtualizar cargo do membro
/workspaces/{workspaceId}/members/{userId}/role - PUTAtualizar cargo personalizado
/workspaces/{workspaceId}/roles/{roleId} - PATCHExigir a verificação em duas etapas no workspace
/workspace/security - PATCHExigir o login único em um domínio
/workspace/sso/domains/{domainId} - DELETERemover a conexão de login único
/workspace/sso/connection - DELETERemover um domínio
/workspace/sso/domains/{domainId} - DELETERemover atribuição de recurso
/workspaces/{workspaceId}/assignments/{resourceType}/{resourceId}/members/{userId} - DELETECancelar convite
/workspaces/{workspaceId}/invites/{inviteId} - DELETERemover membro
/workspaces/{workspaceId}/members/{userId} - DELETEExcluir cargo personalizado
/workspaces/{workspaceId}/roles/{roleId}