Pular para o conteúdo principal
PATCH
/
v1
/
provider-configurations
/
{id}
Atualizar uma configuração de provedor
curl --request PATCH \
  --url https://flowker.sandbox.lerian.net/v1/provider-configurations/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "config": {},
  "description": "ClearSale anti-fraud — updated with new API version",
  "metadata": {},
  "name": "ClearSale Production v2"
}
'
{
  "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "name": "ClearSale Production",
  "description": "ClearSale anti-fraud for Pix transactions",
  "providerId": "clearsale",
  "config": {
    "baseUrl": "https://api.clearsale.com.br",
    "environment": "production"
  },
  "status": "active",
  "metadata": {
    "team": "risk"
  },
  "createdAt": "2026-03-17T14:00:00Z",
  "updatedAt": "2026-03-17T14:00:00Z"
}

Autorizações

​
X-API-Key
string
header
obrigatório

API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during deployment.

Parâmetros de caminho

​
id
string<uuid>
obrigatório

Identificador único da configuração do provedor.

Corpo

application/json

Corpo da solicitação contendo os detalhes atualizados da configuração do provedor.

​
config
object

Configuração específica do provedor atualizada.

​
description
string

Descrição atualizada.

Maximum string length: 500
Exemplo:

"ClearSale anti-fraud — updated with new API version"

​
metadata
object

Metadados atualizados.

​
name
string

Nome atualizado.

Required string length: 1 - 100
Exemplo:

"ClearSale Production v2"

Resposta

Indica que a solicitação foi bem-sucedida e a resposta contém os dados solicitados.

​
config
object

Configuração específica do provedor.

Exemplo:
{
  "baseUrl": "https://api.clearsale.com.br",
  "environment": "production"
}
​
createdAt
string<date-time>

Marca temporal de quando a configuração foi criada.

Exemplo:

"2026-03-17T14:00:00Z"

​
description
string

Descrição legível por humanos.

Exemplo:

"ClearSale anti-fraud for Pix transactions"

​
id
string<uuid>

Identificador único da configuração.

Exemplo:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

​
metadata
object

Metadados personalizados.

Exemplo:
{
  "environment": "production",
  "team": "risk"
}
​
name
string

Nome da configuração.

Exemplo:

"ClearSale Production"

​
providerId
string

ID do provedor do catálogo.

Exemplo:

"clearsale"

​
status
enum<string>

Status atual: active ou disabled.

Opções disponíveis:
active,
disabled
Exemplo:

"active"

​
updatedAt
string<date-time>

Marca temporal da última atualização.

Exemplo:

"2026-03-17T14:00:00Z"