POST/v1/4bridge/connector-types/admin

Create connector types admin

Not yet documented — no summary in the API source.

RequiresAuthorization: Bearer sk_...tenant_id

Request body application/json

connectorTypestringnullable
displayNamestringnullable
descriptionstringnullable
iconstringnullable
categorystringnullable
supportedAuthTypesarray of stringnullable
configFieldsarray of objectCreateFieldDefinitionRequestnullable
namestringnullable
labelstringnullable
fieldTypestringnullable
requiredboolean
placeholderstringnullable
helpTextstringnullable
defaultValuestringnullable
optionsarray of objectCreateSelectOptionRequestnullable
valuestringnullable
labelstringnullable
descriptionstringnullable
validationPatternstringnullable
validationMessagestringnullable
orderinteger (int32)
showWhenstringnullable
minLengthinteger (int32)nullable
maxLengthinteger (int32)nullable
secretFieldsarray of objectCreateFieldDefinitionRequestnullable
namestringnullable
labelstringnullable
fieldTypestringnullable
requiredboolean
placeholderstringnullable
helpTextstringnullable
defaultValuestringnullable
optionsarray of objectCreateSelectOptionRequestnullable
valuestringnullable
labelstringnullable
descriptionstringnullable
validationPatternstringnullable
validationMessagestringnullable
orderinteger (int32)
showWhenstringnullable
minLengthinteger (int32)nullable
maxLengthinteger (int32)nullable
supportsTestConnectionboolean
documentationUrlstringnullable
displayOrderinteger (int32)

Responses

idstringnullable
connectorTypestringnullable
displayNamestringnullable
descriptionstringnullable
iconstringnullable
categorystringnullable
supportedAuthTypesarray of stringnullable
configFieldsarray of objectFieldDefinitionResponsenullable
namestringnullable
labelstringnullable
fieldTypestringnullable
requiredboolean
placeholderstringnullable
helpTextstringnullable
defaultValuestringnullable
optionsarray of objectSelectOptionResponsenullable
valuestringnullable
labelstringnullable
descriptionstringnullable
validationPatternstringnullable
validationMessagestringnullable
orderinteger (int32)
showWhenstringnullable
minLengthinteger (int32)nullable
maxLengthinteger (int32)nullable
secretFieldsarray of objectFieldDefinitionResponsenullable
namestringnullable
labelstringnullable
fieldTypestringnullable
requiredboolean
placeholderstringnullable
helpTextstringnullable
defaultValuestringnullable
optionsarray of objectSelectOptionResponsenullable
valuestringnullable
labelstringnullable
descriptionstringnullable
validationPatternstringnullable
validationMessagestringnullable
orderinteger (int32)
showWhenstringnullable
minLengthinteger (int32)nullable
maxLengthinteger (int32)nullable
isActiveboolean
supportsTestConnectionboolean
documentationUrlstringnullable
credentialsHelpstringnullable
displayOrderinteger (int32)
isSystemManagedOnlyboolean
curl --request POST \
  --url 'https://api.4comply.io/v1/4bridge/connector-types/admin' \
  --header 'Authorization: Bearer sk_...' \
  --header 'tenant_id: your-tenant-id' \
  --header 'Content-Type: application/json' \
  --data '{
  "connectorType": "string",
  "displayName": "Example name",
  "description": "Example text",
  "icon": "string",
  "category": "string",
  "supportedAuthTypes": [
    "string"
  ],
  "configFields": [
    {
      "name": "Example name",
      "label": "Example label",
      "fieldType": "string",
      "required": true,
      "placeholder": "string",
      "helpText": "string",
      "defaultValue": "string",
      "options": [
        {
          "value": "string",
          "label": "Example label",
          "description": "Example text"
        }
      ],
      "validationPattern": "string",
      "validationMessage": "string",
      "order": 1,
      "showWhen": "string",
      "minLength": 1,
      "maxLength": 1
    }
  ],
  "secretFields": [
    {
      "name": "Example name",
      "label": "Example label",
      "fieldType": "string",
      "required": true,
      "placeholder": "string",
      "helpText": "string",
      "defaultValue": "string",
      "options": [
        {
          "value": "string",
          "label": "Example label",
          "description": "Example text"
        }
      ],
      "validationPattern": "string",
      "validationMessage": "string",
      "order": 1,
      "showWhen": "string",
      "minLength": 1,
      "maxLength": 1
    }
  ],
  "supportsTestConnection": true,
  "documentationUrl": "https://example.com",
  "displayOrder": 1
}'