Skip to main content
POST
Create a Provider Configuration

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.

Body

application/json

Request body containing the provider configuration details.

config
object
required

Provider-specific configuration that is validated against the provider's JSON Schema.

Example:
name
string
required

Unique name for this provider configuration.

Required string length: 1 - 100
Example:

"ClearSale Production"

providerId
string
required

ID of the catalog provider to configure. Must match a registered provider.

Example:

"clearsale"

description
string

Human-readable description of this provider configuration.

Maximum string length: 500
Example:

"ClearSale anti-fraud for Pix transactions"

metadata
object

Custom key-value pairs for tagging.

Example:

Response

Indicates that the resource was successfully created and the operation was completed as expected.

createdAt
string<date-time>

Timestamp when the configuration was created.

Example:

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

id
string<uuid>

Unique identifier of the created configuration.

Example:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

name
string

Name of the configuration.

Example:

"ClearSale Production"

status
string

Initial status (always active on creation).

Example:

"active"