Atualizar grupo

Endpoint: PUT/PATCH /user/groups/{id}/

Autenticação: JWT obrigatório

Atualiza o name e/ou as permissions do grupo. Quando permissions é informado, as permissões do grupo são totalmente substituídas pela nova lista (é uma operação de definição, não de adição). Quando permissions é omitido, o conjunto atual é preservado. O grupo de identificador 1 recebe tratamento especial: tentativas de renomeá-lo são silenciosamente descartadas (o campo name é removido dos dados validados antes de salvar). Ainda assim, é possível alterar as suas permissões.

Pré-requisitos

O grupo precisa existir.
Quem faz a chamada precisa ser superusuário ou possuir a permissão auth.manage_groups.

Parâmetros de rota

integer

required

Identificador do grupo.

Corpo da requisição

string

Novo nome. Ignorado se id == 1.

integer[]

Nova lista de identificadores de permissão. Omita para manter o conjunto atual.

Resposta

Retorna o grupo atualizado.

integer

string

integer[]

Lista completa e nova de identificadores de permissão.

{
  "id": 3,
  "name": "Account Admin",
  "permissions": [101, 102, 104]
}

Erros

Status	Quando
`400`	`name` em conflito com outro grupo, ou identificador de permissão inválido / não permitido.
`401`	Token ausente ou inválido.
`403`	Quem chama não possui `auth.manage_groups`.
`404`	Nenhum grupo corresponde ao identificador informado.

Exemplos

curl -X PATCH https://api.dlpay.cloud/user/groups/3/ \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"permissions": [101, 102, 104]}'

import requests

response = requests.patch(
    "https://api.dlpay.cloud/user/groups/3/",
    headers={"Authorization": f"Bearer {access_token}"},
    json={"permissions": [101, 102, 104]},
)
group = response.json()

const response = await fetch("https://api.dlpay.cloud/user/groups/3/", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ permissions: [101, 102, 104] }),
});
const group = await response.json();

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Pré-requisitos

Parâmetros de rota

Corpo da requisição

Resposta

Erros

Exemplos

​Pré-requisitos

​Parâmetros de rota

​Corpo da requisição

​Resposta

​Erros

​Exemplos

Pré-requisitos

Parâmetros de rota

Corpo da requisição

Resposta

Erros

Exemplos