Grupos
Liste, consulte, crie, altere e exclua grupos de usuários .
Use estas operações para manter o catálogo de grupos: um ERP que cria o grupo "Atacado Sul" quando abre uma nova tabela comercial, um painel que lista os grupos para o atendente escolher, uma rotina que remove grupos de campanhas antigas. Para colocar pessoas nos grupos, veja Vínculo com grupos.
Os conceitos (tipos C, V e A, status do grupo, campos extras) estão em Grupos de usuários. Um grupo novo nasce sem membros e sem privilégios.
/api/v1/admin/usergroupsAdminLista os grupos de usuários
Exige manage_usergroups. Devolve todos os grupos que atendem ao filtro, ordenados pelo nome.
Query parameters
typestringCVAstatusstringAHDactive, hidden, disabled).Campos da resposta
iduuidnamestringdescriptionstringtypestringCVAstatusstringAHDvendor_manageablebooleanmembers_countintegerinternal_codestringcompany_iduuidlegacy_idintegertotalinteger/api/v1/admin/usergroups/{id}AdminConsulta um grupo de usuários com seus membros
Devolve o grupo e a lista de membros, com o status de cada vínculo. Exige manage_usergroups. Grupos de audiência de campanha podem ter milhares de membros; prefira a lista quando só precisa do cabeçalho.
Path parameters
iduuidobrigatórioCampos da resposta
membersarraymembers[].iduuidmembers[].user_iduuidmembers[].link_statusstringAPFDmembers_countintegerOs demais campos são os da lista (internal_code não vem nesta resposta).
/api/v1/admin/usergroupsAdminCria um grupo de usuários
Exige manage_usergroups. Só o nome é obrigatório; type e status assumem C e A quando faltam ou são desconhecidos.
Corpo da requisição
namestringobrigatóriodescriptionstringtypestringpadrão: CCVAC.statusstringpadrão: AAHDA.vendor_manageablebooleanpadrão: falsecompany_iduuidinternal_codestringExemplo de requisição
Resposta
/api/v1/admin/usergroups/{id}AdminAtualiza um grupo de usuários
Altera só os campos enviados e devolve o grupo atualizado. Exige manage_usergroups.
Path parameters
iduuidobrigatórioCorpo da requisição
namestringdescriptionstringtypestringCVAstatusstringAHDvendor_manageablebooleancompany_iduuid"" ou "0" volta a valer para todos.internal_codestring/api/v1/admin/usergroups/{id}AdminExclui um grupo de usuários
Exclui o grupo e todos os vínculos dele. Exige manage_usergroups.
Path parameters
iduuidobrigatórioErros
| Status | Quando | Corpo |
|---|---|---|
| 400 | Corpo que não é JSON | {"error":"invalid request body","detail":"..."} |
| 400 | Falta name ao criar | {"error":"name is required"} |
| 401 | Sem credenciais ou token expirado | {"error":"invalid or expired token"} |
| 403 | Falta manage_usergroups | {"error":"insufficient privileges","required":"manage_usergroups"} |
| 404 | Grupo inexistente em consultar e alterar | {"error":"usergroup not found"} |
| 500 | status inválido ao alterar | {"error":"failed to update usergroup","detail":"invalid status: \"zz\" (must be A/H/D or active/hidden/disabled)"} |
| 500 | Excluir um grupo que não existe | {"error":"failed to delete usergroup","detail":"usergroup ... not found"} |