Search docs/

Deletar membro especificado

{...}

Remover o membro específicado do Layers. Esse processo pode ser revertido por meio da rota de editar membro altetando a chave active de false para true.

DELETE https://api.layers.digital/v1/members/{memberId}
CopiarCopiado

Autenticação

Autenticação do tipo Token Bearer é necessária para acessar essa rota. O app deve estar cadastrado para usar a API com a permissão member:write

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade
  • memberId
    (path)
    obrigatório
    Identificador do membro.

Resposta

Especificação

  • idString

    Identificador do documento do membro

  • createdAtString

    Data de criação do membro em UTC corrigido para o fuso da comunidade

  • updatedAtString

    Data da última modificação do membro em UTC corrido para o fuso da comunidade

  • activeBoolean

    Chave que indica se o membro está ativo (quando o membro é apagado, essa chave é mudada para false)

  • communityString

    Identificador da communidade do membro

  • accessObject[ ]

  • nameStringobrigatório

    Nome do membro

  • aliasStringobrigatório

    RA do membro

  • birthString

    Data de nascimento

Exemplo

{
  "id": "12345678",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedAt": "2020-01-01T00:00:00.000Z",
  "active": true,
  "community": "test",
  "access": [
    {
      "permissions": [
        "guardian"
      ],
      "user": "exemplo"
    }
  ],
  "name": "Gabriel Raniere",
  "alias": "abc123d",
  "birth": "2010-04-10T00:00:00.000Z"
}
CopiarCopiado