Grupos

Nesta página, vamos explorar os diferentes endpoints de grupos que você pode usar para gerenciar grupos programaticamente. Vamos ver como consultar, criar, atualizar e excluir grupos.

O Modelo de Grupo

O modelo de grupo contém todas as informações sobre seus grupos.

Propriedades

Name
id
Type
integer
Description
Identificador único do grupo.
Name
name
Type
string
Description
O nome do grupo.
Name
members_count
Type
integer
Description
O número de contatos que estão neste grupo.
Name
created
Type
timestamp
Description
Momento da criação do grupo.

{
    "id": 17923,
    "name": "Gruppe 1",
    "members_count": 543,
    "created": "2023-12-21 21:59:53"
}

GET/api/groups

Listar todos os grupos

Este endpoint permite que você recupere uma lista paginada de todos os seus grupos. Por padrão, são exibidos no máximo dez grupos por página.

Parâmetros Opcionais

Name
limit
Type
integer
Description
Limite o número de grupos retornados.
Name
offset
Type
integer
Description
O ponto de início a partir do qual a lista deve ser exibida.

Requisição

GET

/api/groups

curl -G https://gateway.seven.io/api/groups \
    -H "X-Api-Key: SUA_CHAVE_API" \
    -d limit=10

Resposta

{
    "pagingMetadata": {
        "offset": 0,
        "count": 4,
        "total": 40,
        "limit": 30,
        "has_more": false
    },
    "data": [
        {
            "id": 17923,
            "name": "Gruppe 1",
            "members_count": 543,
            "created": "2023-12-21 21:59:53"
        }
    ]
}

POST/api/groups

Criar grupo

Este endpoint permite que você crie um novo grupo.

Parâmetros obrigatórios

Name
name
Type
string
Description
O nome do grupo

Requisição

POST

/api/groups

curl https://gateway.seven.io/api/groups \
    -H "X-Api-Key: SUA_CHAVE_API" \
    -d "name=Um novo grupo"

Resposta

{
    "id": 17923,
    "name": "Eine neue Gruppe",
    "members_count": 0,
    "created": "2023-12-21 21:59:53"
}

GET/api/groups/:id

Obter um grupo

Este endpoint permite que você obtenha um grupo especificando o ID do grupo. Quais propriedades pertencem aos objetos de grupo podem ser encontradas na lista acima nesta página.

Requisição

GET

/api/groups/17923

curl https://gateway.seven.io/api/groups/17923 \
    -H "X-Api-Key: SUA_CHAVE_API"

Resposta

{
    "id": 17923,
    "name": "Eine neue Gruppe",
    "members_count": 0,
    "created": "2023-12-21 21:59:53",
}

PATCH/api/groups/:id

Atualizar um grupo

Este endpoint permite que você atualize um grupo. Exemplos de atualizações incluem alterar o nome, a descrição e o avatar ou adicionar e remover contatos do grupo.

Parâmetros opcionais

Name
name
Type
string
Description
O nome do grupo.

Requisição

PATCH

/api/groups/17923

curl -X PATCH https://gateway.seven.io/api/groups/17923 \
    -H "X-Api-Key: SUA_CHAVE_API" \
    -d "name=Novo nome do grupo"

Resposta

{
    "id": 17923,
    "name": "Neuer Gruppenname",
    "members_count": 543,
    "created": "2023-12-21 21:59:53"
}

DELETE/api/groups/:id

Excluir grupo

Este endpoint permite que você exclua grupos.

Parâmetros Opcionais

Name
delete_contacts
Type
boolean
Description
Indica se os contatos que são membros deste grupo também devem ser excluídos.

Requisição

DELETE

/api/groups/17923

curl -X DELETE https://gateway.seven.io/api/groups/17923 \
    -H "X-Api-Key: SUA_CHAVE_API" \
    -d "delete_contacts=false"