Gerenciar membros da List

​

Guia de Introdução rápida para gerenciar membros de List

Observação: Este guia pressupõe que você concluiu os pré-requisitos na visão geral de Introdução rápida.

​

Etapas para criar uma solicitação para gerenciar membros de uma List

​

Etapa um: escolha a coleção de endpoint de List no Postman

Depois de carregar a coleção X API v2 no Postman, navegue até a pasta “List”, selecione a pasta “List members” e, em seguida, escolha “Add a member”.  

​

Etapa dois: Especifique o usuário a ser adicionado

Os endpoints de gerenciamento de membros de List exigem dois IDs: o ID da List e o ID do usuário a ser adicionado. Você pode encontrar o ID do usuário usando o users lookup e passar um nome de usuário para receber o campo id.

O ID de destino pode ser qualquer ID de usuário válido. No Postman, vá até a aba “Params” e insira seu ID na coluna “Value” da variável de caminho id. Em seguida, vá até a aba “Body” e insira o ID do usuário que você deseja adicionar como valor do parâmetro user_id. Certifique-se de não incluir espaços antes ou depois de nenhum ID.

Key	Value	Parameter type
id	O ID da List	path
user_id	O ID do usuário de destino que você deseja adicionar como membro	body

Agora você deve ver uma URL semelhante ao lado do botão “Send”:

https://api.x.com/2/lists/1441162269824405510/members

Etapa três: Envie sua solicitação e revise a resposta

Depois que tudo estiver configurado, clique no botão “Send” e você receberá uma resposta semelhante ao exemplo a seguir:

{
  "data": {
    "is_member": true
  }
}

Se o objeto de resposta retornado contiver o valor true para a chave is_member, o usuário foi adicionado com sucesso como membro da List.

Para remover um membro de uma List, selecione a requisição “Remove a member”, também localizada na pasta “Lists” da coleção X API v2 carregada no Postman. Este endpoint requer o ID da List e o ID do usuário do membro que você deseja remover. Na aba “Params”, insira o ID da List como valor na coluna id e o ID do usuário a ser removido como valor na coluna user_id.

Em uma requisição DELETE bem-sucedida, você receberá uma resposta semelhante ao seguinte exemplo:

{
  "data": {
    "is_member": false
  }
}