O que esse endpoint de API faz

Com a API de grupos, você cria ou exclui um grupo e atualiza o nome de um grupo. Os administradores veem essas alterações refletidas na guia Pessoas. Você também usa esse endpoint para recuperar uma lista de grupos ou detalhes de um grupo específico.

• Endpoints
• Objeto de grupo
• Criar grupo
• Listar grupos
• Recuperar por ID de grupo
• Atualização por ID de grupo
• Excluir por ID de grupo

Endpoints

• POST /groups- criar um novo grupo
• GET /groups- grupos de listas
• GET /groups/{groupId}- obtenha detalhes de um grupo por ID de grupo
• PUT /groups/{groupId}- atualizar um grupo por id de grupo
• DELETE /groups/{groupId}- excluir um grupo por id de grupo

Objeto de grupo

• id(string) - o identificador exclusivo do grupo
• membersUrl(string) - URL para listar os membros do grupo a partir da API
• reportersUrl(string) - URL para listar repórteres do grupo a partir da API
• managersUrl(string) - URL para listar gerenciadores de grupos da API
• name(string) - o nome do grupo
• url(string) - URL para buscar os detalhes do grupo na API

Criar grupo

POST /groups

Parâmetros de solicitação (JSON)

• name(string, obrigatório) - o nome do grupo

Exemplo de resposta

{
“id”: “example-group-id”, 
 “membersURL”: "https://api.reach360.com/groups/example-group-id/users “, “reportersURL”: "https://api.reach360.com/groups/example-group-id/reporters 
 “, “managersURL”: "https://api.reach360.com/groups/example-group-id/managers “, 
 “name”: “Exemplo de grupo”, 
 “url”: "https://api.reach360.com/groups/example-group-id"} 
 

Códigos de erro específicos do endpoint

• code: 'duplicate_name'- não é possível criar um grupo porque name já existe um grupo com o especificado

Listar grupos

GET /groups

Parâmetros de solicitação (sequência de caracteres de consulta)

• limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 100 (o padrão é 50)
• name(string, opcional) - Retorna grupos com o nome especificado.

Exemplo de resposta

{
“groups”: [
{
“id”: “example-group-id-1", 
 “membersURL”: "https://api.reach360.com/groups/example-group-id/users “, “reportersURL”: "https://api.reach360.com/groups/example-group-id-1/reporters 
 “, “managersURL”: "https://api.reach360.com/groups/example-group-id-1/managers “, “name”: 
 “Exemplo de grupo” “url”: "https://api.reach60.com/groups/example-group-id-1"},
... 
 
 
], 
 “NextURL”: "https://url-for-next-page-of-results"} 

Recuperar grupo por ID

GET /groups/{groupId}

Exemplo de resposta

{
“id”: “example-group-id”, 
 “membersURL”: "https://api.reach360.com/groups/example-group-id/users “, “reportersURL”: "https://api.reach360.com/groups/example-group-id/reporters 
 “, “managersURL”: "https://api.reach360.com/groups/example-group-id/managers “, 
 “name”: “Exemplo de grupo” “url”: "https://api.reach360.com/groups/example-group-id"} 
 
 

Códigos de erro específicos do endpoint

• group_not_found- não é possível recuperar o grupo porque o grupo não existe

Atualizar grupo por ID

PUT /groups/{groupId}

Parâmetros de solicitação (JSON)

• name(string, obrigatório) - o nome do grupo

Resposta de sucesso

204 “Sem conteúdo”

Códigos de erro específicos do endpoint:

• group_not_found- não é possível atualizar o grupo porque o grupo não existe
• read_only_group- não é possível fazer alterações no grupo especificado (exemplo: você não pode modificar o grupo “Todos”)

Excluir grupo por ID

DELETE /groups/{groupId}

Resposta de sucesso

204 “Sem conteúdo”

Códigos de erro específicos do endpoint:

• group_not_found- não é possível excluir o grupo porque o grupo não existe
• read_only_group- não é possível excluir o grupo especificado (exemplo: você não pode modificar o grupo “Todos”)