Skip to main content
POST
/
integrations
/
vertofx
Add VertoFx Integrations
curl --request POST \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/integrations/vertofx \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Royalti Demo Verto Integrations",
  "apiKey": "9JP4FKWP0TMTDFPYHGSEIUGFBWEFHGSLQVSHJF2KTR17HGSGHFKHGDBSJFVG",
  "clientId": "H812JHVLSDKJFBVKLJDBSFVBDFUVS86Y5"
}'
{
  "id": "d3fa97e3-2573-4695-9d1d-516f8b11d874",
  "name": "Royalti Demo Verto Integrations",
  "enabled": true,
  "settings": {
    "apiKey": "9JP4FKWP0TMTDFPYHGSEIUGFBWEFHGSLQVSHJF2KTR17HGSGHFKHGDBSJFVG",
    "clientId": "H812JHVLSDKJFBVKLJDBSFVBDFUVS86Y5"
  },
  "memo": null,
  "TenantId": 2,
  "IntegrationId": "a4ab3109-b247-431c-a7c0-fd004a851475",
  "updatedAt": "2024-04-11T21:14:49.622Z",
  "createdAt": "2024-04-11T21:14:49.622Z",
  "metadata": null
}
Create VertoFX Integration Endpoint: /integrations/vertofx
Method: POST
Request Body
FieldTypeRequiredDescription
namestringYesName of the VertoFX integration instance.
apiKeystringYesAPI key for the VertoFX integration.
clientIdstringYesClient ID for the VertoFX integration.
This endpoint allows you to create a new integration instance for VertoFX by providing a name, an API key, and a client ID.

Authentication

This endpoint requires authentication. Include your bearer token in the Authorization header.

Request Body

Example Request

{
  "name": "Royalti Demo Verto Integrations",
  "apiKey": "9JP4FKWP0TMTDFPYHGSEIUGFBWEFHGSLQVSHJF2KTR17HGSGHFKHGDBSJFVG",
  "clientId": "H812JHVLSDKJFBVKLJDBSFVBDFUVS86Y5"
}

Request Schema

FieldTypeRequiredDescription
namestringName of the VertoFX integration instance
apiKeystringAPI key for the VertoFX integration
clientIdstringClient ID for the VertoFX integration
memostringOptional memo for the integration

Responses

✅ 201 - Success

⚠️ 400 - Bad Request

⚠️ 401 - Unauthorized

❌ 500 - Internal Server Error

Tags

VertoFx

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
I