vértice
Produto Preços Painel
Comunidades

Comunidades

Criação, grupos vinculados, participantes, admins, convites e configurações de comunidades.

Referência

16 endpoints

GET /instances/:id/communities →

Listar comunidades

Lista as comunidades das quais o número participa.

API key · Escopo read
POST /instances/:id/communities →

Criar comunidade

Cria uma comunidade com nome e descrição.

API key · Escopo write
GET /instances/:id/communities/invite/:code →

Metadados de convite de comunidade

Metadados de convite de comunidade.

API key · Escopo read
POST /instances/:id/communities/join →

Entrar em comunidade por convite

Entra em comunidade por convite.

API key · Escopo write
GET /instances/:id/communities/:jid →

Metadados da comunidade

Retorna metadados e participantes da comunidade.

API key · Escopo read
PATCH /instances/:id/communities/:jid →

Atualizar nome/descrição

Atualiza nome/descrição.

API key · Escopo write
DELETE /instances/:id/communities/:jid →

Sair da comunidade

Sai da comunidade.

API key · Escopo write
POST /instances/:id/communities/:jid/leave →

Sair da comunidade

Sai da comunidade.

API key · Escopo write
GET /instances/:id/communities/:jid/groups →

Listar grupos vinculados

Lista os grupos vinculados à comunidade.

API key · Escopo read
POST /instances/:id/communities/:jid/groups →

Criar/vincula grupo à comunidade

Cria um grupo vinculado ou vincula grupos existentes.

API key · Escopo write
DELETE /instances/:id/communities/:jid/groups →

Desvincular grupos

Desvincula grupos da comunidade.

API key · Escopo write
GET /instances/:id/communities/:jid/invite →

Link de convite da comunidade

Retorna o link de convite da comunidade.

API key · Escopo read
POST /instances/:id/communities/:jid/invite/revoke →

Revogar link de convite

Revoga e gera um novo link de convite.

API key · Escopo write
GET /instances/:id/communities/:jid/requests →

Solicitações de entrada

Lista solicitações de entrada na comunidade.

API key · Escopo read
POST /instances/:id/communities/:jid/participants →

Gerencia participantes

Adiciona, remove, promove, rebaixa, aprova ou rejeita participantes.

API key · Escopo write
PATCH /instances/:id/communities/:jid/settings →

Configurações da comunidade

Altera restrições, modo de adição e aprovação de entrada.

API key · Escopo write