Skip to main content
POST
Add VertoFx Integrations
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Endpoint: /integrations/vertofx Authorization:
  • Required role: owner only
Method: POST Request Body This endpoint allows you to create a new integration instance for VertoFX by providing a name, an API key, and a client ID.

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
name
string
required

Name of the VertoFX integration instance

apiKey
string
required

API key for the VertoFX integration

clientId
string
required

Client ID for the VertoFX integration

memo
string

Optional memo for the integration

Response

Success

id
string
name
string
enabled
boolean
settings
object
memo
string | null
TenantId
integer
IntegrationId
string
updatedAt
string<date-time>
createdAt
string<date-time>
metadata
object | null