---
title: "Create tenant integration"
method: POST
path: "/v1/platform/{tenancyid}/integrations"
tags: ["platform v1"]
---

# Create tenant integration

`POST /v1/platform/{tenancyid}/integrations`

## Request

- Base URL: `https://docs.dev.causeway.com/api`
- URL: `https://docs.dev.causeway.com/api/v1/platform/{tenancyid}/integrations`
- Auth: HTTP bearer

Create tenancy intetgrations.

## Request body

- PostV1PlatformTenancyidIntegrationsRequest
  - `type` string, required: The identifier
  - `tenant_name` string, required: The the Org name incase we have to create a tenancy within Docs
  - `definition` object, required
    - `location` string[]: folder by which the future upload will be stored
    - `autoFieldGeneration` boolean: Wheather to dynamically update the integration defintion with unlisted fields
    - `fields` object[]: Details of the fields to be provided at upload time
      - `name` string: The key on the future upload
      - `label` string: A display label
      - `type` string: Can be ["text" | "date" | "number"]
      - `metaTag` boolean: Create a MetaTag for this field
      - `facet` boolean: Sets MetaTag setting
      - `advancedSearch` boolean: Sets MetaTag setting
      - `documentPreview` boolean: Sets MetaTag setting
      - `tagValue` boolean: Should be added to the documents ref tag
    - `project` object
      - `name` string: The name of the project to be created. Can be a reference to fields via syntax "field:"
    - `metaGroup` object
      - `name` string: Name of the Metagroup
      - `metaTags` object[]: MetaTags to be included in the metagroup
        - `field` string: Must match a field name provided
        - `mandatory` boolean: Set the setting
        - `sticky` boolean: Set the setting
        - `processUpdateOnly` boolean: Set the setting
        - `bulkUpdate` boolean: Set the setting
        - `forceLockInProcess` boolean: Set the setting

---

[API](https://skmtc.dev/causeway/apis/causeway-api.md) - [All operations](https://skmtc.dev/causeway/apis/causeway-api/llms.txt) - [OpenAPI document](https://skmtc.dev/causeway/apis/causeway-api/revisions/b75c118139f8?raw)