Skip to main content
PATCH
/
v1
/
provider-configurations
/
{id}
Update a Provider Configuration
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"
}

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Unique identifier of the provider configuration.

Body

application/json

Request body containing the updated provider configuration details.

​
config
object

Updated provider-specific configuration.

​
description
string

Updated description.

Maximum string length: 500
Example:

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

​
metadata
object

Updated metadata.

​
name
string

Updated name.

Required string length: 1 - 100
Example:

"ClearSale Production v2"

Response

Indicates that the request was successful and the response contains the requested data.

​
config
object

Provider-specific configuration.

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

Timestamp when the configuration was created.

Example:

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

​
description
string

Human-readable description.

Example:

"ClearSale anti-fraud for Pix transactions"

​
id
string<uuid>

Unique identifier of the configuration.

Example:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

​
metadata
object

Custom metadata.

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

Name of the configuration.

Example:

"ClearSale Production"

​
providerId
string

ID of the catalog provider.

Example:

"clearsale"

​
status
enum<string>

Current status: active or disabled.

Available options:
active,
disabled
Example:

"active"

​
updatedAt
string<date-time>

Timestamp of the last update.

Example:

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