Skip to main content
PATCH
Update an Executor Configuration

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider. Send it in the Authorization header as Bearer <token>.

Parámetros de ruta

id
string<uuid>
requerido

Unique identifier of the executor configuration.

Cuerpo

application/json

Request body containing the updated executor configuration details.

authentication
object
requerido
baseUrl
string
requerido

Base URL of the external service.

Maximum string length: 500
Ejemplo:

"https://api.serasa.com.br/v2"

endpoints
object[]
requerido

List of HTTP endpoints exposed by this executor.

Minimum array length: 1
name
string
requerido

Display name for the executor configuration.

Required string length: 1 - 100
Ejemplo:

"Serasa KYC"

description
string

Human-readable description of this executor configuration.

Maximum string length: 500
Ejemplo:

"Serasa KYC provider for identity validation"

metadata
object

Custom key-value pairs for tagging.

Respuesta

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

authentication
object
baseUrl
string

Base URL of the external service.

Ejemplo:

"https://api.serasa.com.br/v2"

createdAt
string<date-time>

Timestamp when the configuration was created.

Ejemplo:

"2026-03-15T10:00:00Z"

description
string

Human-readable description.

Ejemplo:

"Serasa identity validation service"

endpoints
object[]

List of configured HTTP endpoints.

id
string<uuid>

Unique identifier of the executor configuration.

Ejemplo:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

lastTestedAt
string<date-time>

Timestamp when the configuration was last verified and ready for activation.

Ejemplo:

"2026-03-16T09:15:00Z"

metadata
object

Custom metadata.

name
string

Display name.

Ejemplo:

"Serasa KYC"

status
string

Current lifecycle status: unconfigured, configured, tested, active, or disabled.

Ejemplo:

"active"

updatedAt
string<date-time>

Timestamp of the last update.

Ejemplo:

"2026-03-16T09:30:00Z"