Atualizar Produto

Quando uma Produto é atualizado com sucesso, a API retorna o código de status HTTP 200 Ok, com os dados da Produto atualizado no corpo da resposta.

Segurança

Para acessar a API, é necessário obter um token de acesso através do fluxo de autenticação OAuth2. Veja mais detalhes em Como obter acesso?

info

Ao gerar o token JWT, não esqueça de utilizar o escopo correto. Caso contrário, a requisição será rejeitada com o código de erro 401 Unauthorized.

Descrição dos campos

Campo	Tipo	Descrição
description	string	Opcional. Descrição do produto.
active	boolean	Opcional. Define se o produto está ativo.

Requisição

PATCH https://api-sandbox.catalisa.com.br/financial-products/api/v1/products/{id} JWT scope: products/update:products

Parâmetros

Nome	Tipo	Descrição
id	string	Identificador único do produto, no formato UUID.

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Content-Type	application/json

Exemplo de Requisição

Corpo da Requisição

{
  "data": {
    "type": "products",
    "attributes": {
      "description": "Empréstimo Pessoal (EP)",
      "active": false,
    }
  }
}

Respostas

Código	Descrição
200	Produto atualizado com sucesso. Retorna os dados do produto atualizado.
401	Não autorizado

Exemplo de uso

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Content-Type", "application/json");

const body = JSON.stringify({
  data: {
    type: "products",
    attributes: {
      description: "Empréstimo Pessoal (EP)",
      active: false
    }
  }
};

const requestOptions = {
  method: "PATCH",
  headers: headers,
  body: body,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/financial-products/api/v1/products/1752d90e-3066-4341-960f-0bf08b48835f",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request PATCH 'https://api-sandbox.catalisa.com.br/financial-products/api/v1/products/1752d90e-3066-4341-960f-0bf08b48835f' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
--data-raw '{
  "data": {
    "type": "products",
    "attributes": {
      "description": "Empréstimo Pessoal (EP)",
      "active": false
    }
  }
}'

Exemplo de Sucesso

{
    "data": {
        "type": "products",
        "id": "1752d90e-3066-4341-960f-0bf08b48835f",
        "attributes": {
            "active": false,
            "description": "Empréstimo Pessoal (EP)",
            "ownerId": "e8fc74b6-273c-4139-afb4-0fefc60750d6"
        },
        "relationships": {
            "partner": {
                "links": {
                    "self": "https://api-sandbox.catalisa.com.br/partners/api/v1/partners/e8fc74b6-273c-4139-afb4-0fefc60750d6"
                },
                "data": {
                    "type": "partners",
                    "id": "e8fc74b6-273c-4139-afb4-0fefc60750d6"
                }
            }
        },
        "links": {
            "self": "https://api-sandbox.catalisa.com.br/financial-products/api/v1/products/1752d90e-3066-4341-960f-0bf08b48835f"
        }
    }
}