Kombo · Schema

PostIntegrationsIntegrationIdSetupLinkRequestBody

ATSEmbedded iPaaSHRISLMSPayrollUnified API

Properties

Name Type Description
language stringnull Language of the setup flow UI.
link_type string The type of link you want to create. `EMBEDDED` is for the [embedded flow](../guides/connect/embedded-flow) using the Kombo Connect SDK (these links are valid for 1 hour) and `MAGIC_LINK` is for [magi
View JSON Schema on GitHub

JSON Schema

kombo-postintegrationsintegrationidsetuplinkrequestbody-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PostIntegrationsIntegrationIdSetupLinkRequestBody",
  "title": "PostIntegrationsIntegrationIdSetupLinkRequestBody",
  "type": "object",
  "properties": {
    "language": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "en",
        "de",
        "fr",
        "it",
        "es"
      ],
      "default": "en",
      "description": "Language of the setup flow UI."
    },
    "link_type": {
      "type": "string",
      "enum": [
        "EMBEDDED",
        "MAGIC_LINK"
      ],
      "description": "The type of link you want to create. `EMBEDDED` is for the [embedded flow](../guides/connect/embedded-flow) using the Kombo Connect SDK (these links are valid for 1 hour) and `MAGIC_LINK` is for [magic links](../guides/connect/magic-links) which you send out manually to customers (these are valid for 1 year)."
    }
  },
  "required": [
    "link_type"
  ]
}