Endpoint: Atualizar Conexão

Este endpoint é usado para atualizar os dados de uma conexão existente. Antes de utilizar este endpoint, certifique-se de realizar o login e obter o token de gestão.

Requisição

        PUT /tools/connections/{id}
    

Parâmetros de entrada

Parâmetro	Tipo	Descrição
id	string	O número da conexão a ser atualizada
name	string	O novo nome da conexão
webhookUrl	string	URL para receber mensagens e atualizações de informações da conexão

Headers

Além dos parâmetros de entrada, a requisição deve incluir os seguintes headers:

Header	Descrição
Content-Type	O tipo de conteúdo da requisição, deve ser "application/json"
Authorization	O token de autorização no formato "Bearer {token de gestão}"

Exemplo de Requisição

        
            PUT /tools/connections/{id} HTTP/1.1
            Host: dev.solubot.com.br
            Content-Type: application/json
            Authorization: Bearer <token de gestão>

            {
                "name":  "<novo nome da conexão>",
                "webhookUrl": "<webhook da conexão>";
            }
        
    

Resposta de Sucesso

Em caso de sucesso, a requisição retornará o código de status 200 OK e os detalhes atualizados da conexão no formato JSON.

        
            HTTP/1.1 200 OK
            Content-Type: application/json

            {
                "id": <id da conexão>,
                "name": <nome da conexão>,
                "session": <informação da sessão>,
                "qrcode": <QR code>,
                "status": <status da conexão>,
                "token": <token da conexão>,
                "webhookUrl": <webhook da conexão>,
                "createdAt": <data e hora de criação>,
                "updatedAt": <data e hora de última atualização>
            }
        
    

Resposta de Erro

Em caso de falha na requisição, serão retornados códigos de status diferentes de 200. A resposta de erro pode conter informações adicionais no corpo da resposta. Os possíveis erros são:

Código	Mensagem	Descrição
400	CONNECTION_NAME_ALREADY_IN_USE	Já existe uma conexão com este nome.
401	ERR_SESSION_EXPIRED	A sessão foi expirada, necessário realizar login novamente.
401	ERR_NO_PERMISSION	O usuário não possui permissão para acessar a conexão.
403	INVALID_TOKEN	O token de autorização fornecido é inválido ou expirou. É necessário fornecer um token válido para acessar a conexão.
404	ERR_NO_CONNECTION_FOUND	Nenhuma conexão encontrada com o ID fornecido.

Uso da Requisição

1. O cliente envia uma requisição PUT para /tools/connections/{id} para atualizar os dados de uma conexão existente.
2. A requisição deve incluir o header "Content-Type" com o valor "application/json" e o header "Authorization" com o token de autorização no formato "Bearer {token de gestão}".
3. O servidor processa a requisição e atualiza os dados da conexão correspondente ao ID fornecido.
4. Em caso de sucesso, o servidor retorna o código de status 200 OK junto com os detalhes atualizados da conexão no formato JSON.
5. Caso ocorra um erro, o servidor retorna um código de status apropriado junto com uma mensagem de erro no corpo da resposta.