Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Provider Configurations API

Update a Provider Configuration

Use this endpoint to update an existing provider configuration. If the configuration payload changes, it is re-validated against the provider's JSON Schema.

patch/v1/provider-configurations/{id}

Path parameters

idstring uuid required

Unique identifier of the provider configuration.

Request body

configobject

Updated provider-specific configuration.

descriptionstring

Updated description.

metadataobject

Updated metadata.

namestring

Updated name.

Example request

{
  "description": "ClearSale anti-fraud — updated with new API version",
  "name": "ClearSale Production v2"
}

Response

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

configobject

Provider-specific configuration.

createdAtstring date-time

Timestamp when the configuration was created.

descriptionstring

Human-readable description.

idstring uuid

Unique identifier of the configuration.

metadataobject

Custom metadata.

namestring

Name of the configuration.

providerIdstring

ID of the catalog provider.

status'active' | 'disabled'

Current status: active or disabled.

updatedAtstring date-time

Timestamp of the last update.

Example response

{
  "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"
}