> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.wbudget.app/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.wbudget.app/_mcp/server. # Atualizar cliente PATCH https://wbudget.app/api/v1/api/v1/clients/{id} Content-Type: application/json Atualiza os dados de um cliente. **Autenticação:** Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário. Campos omitidos, nulos ou vazios preservam os valores atuais. Retorna o cadastro atualizado. ### Parâmetros de caminho | Campo | Tipo | Obrigatório | Descrição | | ----- | ------- | ----------- | -------------- | | `id` | integer | Sim | ID do cliente. | ### Corpo da requisição | Campo | Tipo | Obrigatório | Descrição | | -------------- | ------ | ----------- | ----------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Não | Nome do cliente. | | `email` | string | Não | E-mail válido. | | `phone` | string | Não | Telefone com código do país e DDD. | | `national_id` | string | Não | Documento fiscal; mantenha como texto. | | `sponsor` | string | Não | Nome do contato principal. | | `address` | object | Não | Endereço do cliente. | | `status` | string | Não | Situação do cadastro, conforme os valores usados na conta. | | `metadata` | object | Não | Campos personalizados. | | `main_contact` | object | Não | Dados do contato principal: name, email, nid (documento) e phone. Esse objeto permite criar ou atualizar o contato principal. | ### Exemplo de JSON enviado ```json { "name": "Empresa Exemplo Atualizada", "email": "compras@example.com" } ``` ### Resposta HTTP **200**. Os exemplos usam dados fictícios e mostram os campos principais; outros campos podem acompanhar a resposta. Campos sem valor podem ser nulos. Campos principais de `data`: | Campo | Tipo | Descrição | | --------------------- | --------------- | ---------------------------------------------- | | `id` | integer | ID do cliente. | | `name` | string | Nome. | | `email` | string | E-mail. | | `phone` | string | Telefone. | | `national_id` | string | Documento. | | `sponsor` | string | Contato principal. | | `address` | object | Endereço. | | `status` | string | Situação do cadastro. | | `metadata` | object ou array | Valores personalizados, conforme configuração. | | `contacts` | array\ | Contatos do cliente. | | `contacts[].id` | integer | ID para usar em contactId. | | `contacts[].name` | string | Nome. | | `contacts[].email` | string | E-mail. | | `contacts[].phone` | string | Telefone. | | `contacts[].position` | string | Cargo. | | `contacts[].main` | integer | 1 indica contato principal. | | `contacts[].active` | integer | 1 indica contato ativo. | ```json { "data": { "id": 101, "name": "Empresa Exemplo Atualizada", "sponsor": "Ana Silva", "email": "compras@example.com", "phone": "+5511999990000", "national_id": "11222333000181" } } ``` ### Erros específicos | HTTP | Código | Situação | | ---- | ------------------ | ----------------- | | 404 | `CLIENT_NOT_FOUND` | Client not found. | Consulte a introdução da collection para o formato de erros e a configuração das variáveis. Reference: https://developers.wbudget.app/w-budget/clientes/atualizar-cliente ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `id` (string, required) — ID do cliente. ### Body (application/json) This endpoint expects an object. - `name` (string, required) - `email` (string, required) ## Response ### 200 OK - `data` (object, required) - `id` (integer, required) - `name` (string, required) - `sponsor` (string, required) - `email` (string, required) - `phone` (string, required) - `national_id` (string, required) ## Errors ### 404 Not Found Error Not Found - `error` (object, required) - `message` (string, required) - `code` (string, required) ## Examples **Request** ```json { "name": "Empresa Exemplo Atualizada", "email": "compras@example.com" } ``` **Response** ```json { "data": { "id": 101, "name": "Empresa Exemplo Atualizada", "sponsor": "Ana Silva", "email": "compras@example.com", "phone": "+5511999990000", "national_id": "11222333000181" } } ``` **SDK Code** ```python Clientes_Atualizar cliente_example import requests url = "https://wbudget.app/api/v1/api/v1/clients/101" payload = { "name": "Empresa Exemplo Atualizada", "email": "compras@example.com" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Clientes_Atualizar cliente_example const url = 'https://wbudget.app/api/v1/api/v1/clients/101'; const options = { method: 'PATCH', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"name":"Empresa Exemplo Atualizada","email":"compras@example.com"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Clientes_Atualizar cliente_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://wbudget.app/api/v1/api/v1/clients/101" payload := strings.NewReader("{\n \"name\": \"Empresa Exemplo Atualizada\",\n \"email\": \"compras@example.com\"\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Clientes_Atualizar cliente_example require 'uri' require 'net/http' url = URI("https://wbudget.app/api/v1/api/v1/clients/101") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"Empresa Exemplo Atualizada\",\n \"email\": \"compras@example.com\"\n}" response = http.request(request) puts response.read_body ``` ```java Clientes_Atualizar cliente_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://wbudget.app/api/v1/api/v1/clients/101") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"name\": \"Empresa Exemplo Atualizada\",\n \"email\": \"compras@example.com\"\n}") .asString(); ``` ```php Clientes_Atualizar cliente_example request('PATCH', 'https://wbudget.app/api/v1/api/v1/clients/101', [ 'body' => '{ "name": "Empresa Exemplo Atualizada", "email": "compras@example.com" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Clientes_Atualizar cliente_example using RestSharp; var client = new RestClient("https://wbudget.app/api/v1/api/v1/clients/101"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"Empresa Exemplo Atualizada\",\n \"email\": \"compras@example.com\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Clientes_Atualizar cliente_example import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "name": "Empresa Exemplo Atualizada", "email": "compras@example.com" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://wbudget.app/api/v1/api/v1/clients/101")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```