> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# segment-warehouses

> Segment Warehouses — manage warehouses, reverse ETL, profiles sync, and dbt

**Server path:** `/segment-warehouses` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                                                                  | Description                                                   |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| [`segment_warehouses_add_connection_from_source_to_warehouse`](#segment_warehouses_add_connection_from_source_to_warehouse)                                           | Add Connection from Source to Warehouse                       |
| [`segment_warehouses_cancel_reverse_etlsync_for_model`](#segment_warehouses_cancel_reverse_etlsync_for_model)                                                         | Cancel Reverse ETL Sync for Model                             |
| [`segment_warehouses_create_dbt_model_sync_trigger`](#segment_warehouses_create_dbt_model_sync_trigger)                                                               | Create Dbt Model Sync Trigger                                 |
| [`segment_warehouses_create_profiles_warehouse`](#segment_warehouses_create_profiles_warehouse)                                                                       | Create Profiles Warehouse                                     |
| [`segment_warehouses_create_reverse_etl_model`](#segment_warehouses_create_reverse_etl_model)                                                                         | Create Reverse Etl Model                                      |
| [`segment_warehouses_create_reverse_etlmanual_sync`](#segment_warehouses_create_reverse_etlmanual_sync)                                                               | Create Reverse ETL Manual Sync                                |
| [`segment_warehouses_create_validation_in_warehouse`](#segment_warehouses_create_validation_in_warehouse)                                                             | Create Validation in Warehouse                                |
| [`segment_warehouses_create_warehouse`](#segment_warehouses_create_warehouse)                                                                                         | Create Warehouse                                              |
| [`segment_warehouses_delete_reverse_etl_model`](#segment_warehouses_delete_reverse_etl_model)                                                                         | Delete Reverse Etl Model                                      |
| [`segment_warehouses_delete_warehouse`](#segment_warehouses_delete_warehouse)                                                                                         | Delete Warehouse                                              |
| [`segment_warehouses_get_connection_state_from_warehouse`](#segment_warehouses_get_connection_state_from_warehouse)                                                   | Get Connection State from Warehouse                           |
| [`segment_warehouses_get_reverse_etl_model`](#segment_warehouses_get_reverse_etl_model)                                                                               | Get Reverse Etl Model                                         |
| [`segment_warehouses_get_reverse_etlsync_status`](#segment_warehouses_get_reverse_etlsync_status)                                                                     | Get Reverse ETL Sync Status                                   |
| [`segment_warehouses_get_warehouse`](#segment_warehouses_get_warehouse)                                                                                               | Get Warehouse                                                 |
| [`segment_warehouses_list_connected_sources_from_warehouse`](#segment_warehouses_list_connected_sources_from_warehouse)                                               | List Connected Sources from Warehouse                         |
| [`segment_warehouses_list_profiles_warehouse_in_space`](#segment_warehouses_list_profiles_warehouse_in_space)                                                         | List Profiles Warehouse in Space                              |
| [`segment_warehouses_list_reverse_etl_models`](#segment_warehouses_list_reverse_etl_models)                                                                           | List Reverse Etl Models                                       |
| [`segment_warehouses_list_reverse_etlsync_statuses_from_model_and_subscription_id`](#segment_warehouses_list_reverse_etlsync_statuses_from_model_and_subscription_id) | List Reverse ETL Sync Statuses from Model And Subscription Id |
| [`segment_warehouses_list_selective_syncs_from_warehouse_and_space`](#segment_warehouses_list_selective_syncs_from_warehouse_and_space)                               | List Selective Syncs from Warehouse And Space                 |
| [`segment_warehouses_list_warehouses`](#segment_warehouses_list_warehouses)                                                                                           | List Warehouses                                               |
| [`segment_warehouses_remove_profiles_warehouse_from_space`](#segment_warehouses_remove_profiles_warehouse_from_space)                                                 | Remove Profiles Warehouse from Space                          |
| [`segment_warehouses_remove_source_connection_from_warehouse`](#segment_warehouses_remove_source_connection_from_warehouse)                                           | Remove Source Connection from Warehouse                       |
| [`segment_warehouses_update_profiles_warehouse_for_space_warehouse`](#segment_warehouses_update_profiles_warehouse_for_space_warehouse)                               | Update Profiles Warehouse for Space Warehouse                 |
| [`segment_warehouses_update_reverse_etl_model`](#segment_warehouses_update_reverse_etl_model)                                                                         | Update Reverse Etl Model                                      |
| [`segment_warehouses_update_selective_sync_for_warehouse_and_space`](#segment_warehouses_update_selective_sync_for_warehouse_and_space)                               | Update Selective Sync for Warehouse And Space                 |
| [`segment_warehouses_update_warehouse`](#segment_warehouses_update_warehouse)                                                                                         | Update Warehouse                                              |

***

## segment\_warehouses\_add\_connection\_from\_source\_to\_warehouse

Add Connection from Source to Warehouse

**Parameters:**

| Parameter     | Type   | Required | Default | Description  |
| ------------- | ------ | -------- | ------- | ------------ |
| `warehouseId` | string | Yes      | —       | Warehouse Id |
| `sourceId`    | string | Yes      | —       | Source Id    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "warehouseId": {
        "type": "string",
        "description": "Warehouse Id"
      },
      "sourceId": {
        "type": "string",
        "description": "Source Id"
      }
    },
    "required": [
      "PCID",
      "warehouseId",
      "sourceId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_cancel\_reverse\_etlsync\_for\_model

Cancel Reverse ETL Sync for Model

**Parameters:**

| Parameter            | Type   | Required | Default | Description                                                                                                                        |
| -------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `modelId`            | string | Yes      | —       | Model Id                                                                                                                           |
| `syncId`             | string | Yes      | —       | Sync Id                                                                                                                            |
| `reasonForCanceling` | number | No       | —       | The reason for canceling the sync. - IncorrectModel = 0 - IncorrectDest = 1 - IncorrectKeys = 2 - IncorrectMapping = 3 - Other = 4 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "modelId": {
        "type": "string",
        "description": "Model Id"
      },
      "syncId": {
        "type": "string",
        "description": "Sync Id"
      },
      "reasonForCanceling": {
        "type": "number",
        "description": "The reason for canceling the sync. - IncorrectModel = 0 - IncorrectDest = 1 - IncorrectKeys = 2 - IncorrectMapping = 3 - Other = 4"
      }
    },
    "required": [
      "PCID",
      "modelId",
      "syncId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_create\_dbt\_model\_sync\_trigger

Create Dbt Model Sync Trigger

**Parameters:**

| Parameter  | Type   | Required | Default | Description                                |
| ---------- | ------ | -------- | ------- | ------------------------------------------ |
| `sourceId` | string | Yes      | —       | The Source id to trigger a dbt model sync. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "sourceId": {
        "type": "string",
        "description": "The Source id to trigger a dbt model sync."
      }
    },
    "required": [
      "PCID",
      "sourceId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_create\_profiles\_warehouse

Create Profiles Warehouse

**Parameters:**

| Parameter    | Type    | Required | Default | Description                                                                                                                                                                                                                                                                                                                                                                                      |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `spaceId`    | string  | Yes      | —       | Space Id                                                                                                                                                                                                                                                                                                                                                                                         |
| `enabled`    | boolean | No       | —       | Enable to allow this Warehouse to receive data. Defaults to true.                                                                                                                                                                                                                                                                                                                                |
| `metadataId` | string  | Yes      | —       | The Warehouse metadata to use.                                                                                                                                                                                                                                                                                                                                                                   |
| `name`       | string  | No       | —       | An optional human-readable name for this Warehouse.                                                                                                                                                                                                                                                                                                                                              |
| `schemaName` | string  | No       | —       | The custom schema name that Segment uses on the Warehouse side. The space slug value is default otherwise. The schema name cannot be an existing schema name in the Warehouse. To use an existing schema name, please create a profiles Warehouse through the Segment app UI.                                                                                                                    |
| `settings`   | object  | Yes      | —       | A key-value object that contains instance-specific settings for a Warehouse.  Different kinds of Warehouses require different settings. The required and optional settings for a Warehouse are described in the `options` object of the associated Warehouse metadata.  You can find the full list of Warehouse metadata and related settings information in the `/catalog/warehouses` endpoint. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "spaceId": {
        "type": "string",
        "description": "Space Id"
      },
      "enabled": {
        "type": "boolean",
        "description": "Enable to allow this Warehouse to receive data. Defaults to true."
      },
      "metadataId": {
        "type": "string",
        "description": "The Warehouse metadata to use."
      },
      "name": {
        "type": "string",
        "description": "An optional human-readable name for this Warehouse."
      },
      "schemaName": {
        "type": "string",
        "description": "The custom schema name that Segment uses on the Warehouse side. The space slug value is default otherwise. The schema name cannot be an existing schema name in the Warehouse. To use an existing schema name, please create a profiles Warehouse through the Segment app UI."
      },
      "settings": {
        "description": "A key-value object that contains instance-specific settings for a Warehouse.  Different kinds of Warehouses require different settings. The required and optional settings for a Warehouse are described in the `options` object of the associated Warehouse metadata.  You can find the full list of Warehouse metadata and related settings information in the `/catalog/warehouses` endpoint."
      }
    },
    "required": [
      "PCID",
      "spaceId",
      "metadataId",
      "settings"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_create\_reverse\_etl\_model

Create Reverse Etl Model

**Parameters:**

| Parameter               | Type    | Required | Default | Description                                                                                                                                                                    |
| ----------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `description`           | string  | Yes      | —       | A longer, more descriptive explanation of the Model.                                                                                                                           |
| `enabled`               | boolean | Yes      | —       | Indicates whether the Model should have syncs enabled. When disabled, no syncs will be triggered, regardless of the enabled status of the attached destinations/subscriptions. |
| `name`                  | string  | Yes      | —       | A short, human-readable description of the Model.                                                                                                                              |
| `query`                 | string  | Yes      | —       | The SQL query that will be executed to extract data from the connected Source.                                                                                                 |
| `queryIdentifierColumn` | string  | Yes      | —       | Indicates the column named in `query` that should be used to uniquely identify the extracted records.                                                                          |
| `sourceId`              | string  | Yes      | —       | Indicates which Source to attach this model to.                                                                                                                                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "description": {
        "type": "string",
        "description": "A longer, more descriptive explanation of the Model."
      },
      "enabled": {
        "type": "boolean",
        "description": "Indicates whether the Model should have syncs enabled. When disabled, no syncs will be triggered, regardless of the enabled status of the attached destinations/subscriptions."
      },
      "name": {
        "type": "string",
        "description": "A short, human-readable description of the Model."
      },
      "query": {
        "type": "string",
        "description": "The SQL query that will be executed to extract data from the connected Source."
      },
      "queryIdentifierColumn": {
        "type": "string",
        "description": "Indicates the column named in `query` that should be used to uniquely identify the extracted records."
      },
      "sourceId": {
        "type": "string",
        "description": "Indicates which Source to attach this model to."
      }
    },
    "required": [
      "PCID",
      "description",
      "enabled",
      "name",
      "query",
      "queryIdentifierColumn",
      "sourceId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_create\_reverse\_etlmanual\_sync

Create Reverse ETL Manual Sync

**Parameters:**

| Parameter        | Type   | Required | Default | Description                 |
| ---------------- | ------ | -------- | ------- | --------------------------- |
| `modelId`        | string | Yes      | —       | The id of the Model.        |
| `sourceId`       | string | Yes      | —       | The id of the Source.       |
| `subscriptionId` | string | Yes      | —       | The id of the Subscription. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "modelId": {
        "type": "string",
        "description": "The id of the Model."
      },
      "sourceId": {
        "type": "string",
        "description": "The id of the Source."
      },
      "subscriptionId": {
        "type": "string",
        "description": "The id of the Subscription."
      }
    },
    "required": [
      "PCID",
      "modelId",
      "sourceId",
      "subscriptionId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_create\_validation\_in\_warehouse

Create Validation in Warehouse

**Parameters:**

| Parameter    | Type   | Required | Default | Description                            |
| ------------ | ------ | -------- | ------- | -------------------------------------- |
| `metadataId` | string | Yes      | —       | The id of the Warehouse metadata type. |
| `settings`   | object | Yes      | —       | The settings to check.                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "metadataId": {
        "type": "string",
        "description": "The id of the Warehouse metadata type."
      },
      "settings": {
        "description": "The settings to check."
      }
    },
    "required": [
      "PCID",
      "metadataId",
      "settings"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_create\_warehouse

Create Warehouse

**Parameters:**

| Parameter              | Type    | Required | Default | Description                                                                                                                                                                                                                                                                                                                                                                                      |
| ---------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `disconnectAllSources` | boolean | No       | —       | Whether to disconnect all Sources from this Warehouse.                                                                                                                                                                                                                                                                                                                                           |
| `enabled`              | boolean | No       | —       | Enable to allow this Warehouse to receive data. Defaults to true.                                                                                                                                                                                                                                                                                                                                |
| `metadataId`           | string  | Yes      | —       | The Warehouse metadata to use.                                                                                                                                                                                                                                                                                                                                                                   |
| `name`                 | string  | No       | —       | An optional human-readable name for this Warehouse.                                                                                                                                                                                                                                                                                                                                              |
| `settings`             | object  | Yes      | —       | A key-value object that contains instance-specific settings for a Warehouse.  Different kinds of Warehouses require different settings. The required and optional settings for a Warehouse are described in the `options` object of the associated Warehouse metadata.  You can find the full list of Warehouse metadata and related settings information in the `/catalog/warehouses` endpoint. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "disconnectAllSources": {
        "type": "boolean",
        "description": "Whether to disconnect all Sources from this Warehouse."
      },
      "enabled": {
        "type": "boolean",
        "description": "Enable to allow this Warehouse to receive data. Defaults to true."
      },
      "metadataId": {
        "type": "string",
        "description": "The Warehouse metadata to use."
      },
      "name": {
        "type": "string",
        "description": "An optional human-readable name for this Warehouse."
      },
      "settings": {
        "description": "A key-value object that contains instance-specific settings for a Warehouse.  Different kinds of Warehouses require different settings. The required and optional settings for a Warehouse are described in the `options` object of the associated Warehouse metadata.  You can find the full list of Warehouse metadata and related settings information in the `/catalog/warehouses` endpoint."
      }
    },
    "required": [
      "PCID",
      "metadataId",
      "settings"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_delete\_reverse\_etl\_model

Delete Reverse Etl Model

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `modelId` | string | Yes      | —       | Model Id    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "modelId": {
        "type": "string",
        "description": "Model Id"
      }
    },
    "required": [
      "PCID",
      "modelId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_delete\_warehouse

Delete Warehouse

**Parameters:**

| Parameter     | Type   | Required | Default | Description  |
| ------------- | ------ | -------- | ------- | ------------ |
| `warehouseId` | string | Yes      | —       | Warehouse Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "warehouseId": {
        "type": "string",
        "description": "Warehouse Id"
      }
    },
    "required": [
      "PCID",
      "warehouseId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_get\_connection\_state\_from\_warehouse

Get Connection State from Warehouse

**Parameters:**

| Parameter     | Type   | Required | Default | Description  |
| ------------- | ------ | -------- | ------- | ------------ |
| `warehouseId` | string | Yes      | —       | Warehouse Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "warehouseId": {
        "type": "string",
        "description": "Warehouse Id"
      }
    },
    "required": [
      "PCID",
      "warehouseId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_get\_reverse\_etl\_model

Get Reverse Etl Model

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `modelId` | string | Yes      | —       | Model Id    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "modelId": {
        "type": "string",
        "description": "Model Id"
      }
    },
    "required": [
      "PCID",
      "modelId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_get\_reverse\_etlsync\_status

Get Reverse ETL Sync Status

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `modelId` | string | Yes      | —       | Model Id    |
| `syncId`  | string | Yes      | —       | Sync Id     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "modelId": {
        "type": "string",
        "description": "Model Id"
      },
      "syncId": {
        "type": "string",
        "description": "Sync Id"
      }
    },
    "required": [
      "PCID",
      "modelId",
      "syncId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_get\_warehouse

Get Warehouse

**Parameters:**

| Parameter     | Type   | Required | Default | Description  |
| ------------- | ------ | -------- | ------- | ------------ |
| `warehouseId` | string | Yes      | —       | Warehouse Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "warehouseId": {
        "type": "string",
        "description": "Warehouse Id"
      }
    },
    "required": [
      "PCID",
      "warehouseId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_list\_connected\_sources\_from\_warehouse

List Connected Sources from Warehouse

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                                      |
| ------------- | ------ | -------- | ------- | ---------------------------------------------------------------- |
| `warehouseId` | string | Yes      | —       | Warehouse Id                                                     |
| `pagination`  | object | No       | —       | Defines the pagination parameters.  This parameter exists in v1. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "warehouseId": {
        "type": "string",
        "description": "Warehouse Id"
      },
      "pagination": {
        "type": "object",
        "description": "Defines the pagination parameters.  This parameter exists in v1.",
        "properties": {
          "cursor": {
            "type": "string",
            "description": "The page to request.  Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys.  Consumers of the API must treat this value as opaque."
          },
          "count": {
            "type": "integer",
            "description": "The number of items to retrieve in a page, between 1 and 1000."
          }
        },
        "required": [
          "count"
        ]
      }
    },
    "required": [
      "PCID",
      "warehouseId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_list\_profiles\_warehouse\_in\_space

List Profiles Warehouse in Space

**Parameters:**

| Parameter    | Type   | Required | Default | Description                                                         |
| ------------ | ------ | -------- | ------- | ------------------------------------------------------------------- |
| `spaceId`    | string | Yes      | —       | Space Id                                                            |
| `pagination` | object | No       | —       | Defines the pagination parameters.  This parameter exists in alpha. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "spaceId": {
        "type": "string",
        "description": "Space Id"
      },
      "pagination": {
        "type": "object",
        "description": "Defines the pagination parameters.  This parameter exists in alpha.",
        "properties": {
          "cursor": {
            "type": "string",
            "description": "The page to request.  Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys.  Consumers of the API must treat this value as opaque."
          },
          "count": {
            "type": "integer",
            "description": "The number of items to retrieve in a page, between 1 and 1000."
          }
        },
        "required": [
          "count"
        ]
      }
    },
    "required": [
      "PCID",
      "spaceId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_list\_reverse\_etl\_models

List Reverse Etl Models

**Parameters:**

| Parameter    | Type   | Required | Default | Description                                                         |
| ------------ | ------ | -------- | ------- | ------------------------------------------------------------------- |
| `pagination` | object | No       | —       | Defines the pagination parameters.  This parameter exists in alpha. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "pagination": {
        "type": "object",
        "description": "Defines the pagination parameters.  This parameter exists in alpha.",
        "properties": {
          "cursor": {
            "type": "string",
            "description": "The page to request.  Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys.  Consumers of the API must treat this value as opaque."
          },
          "count": {
            "type": "integer",
            "description": "The number of items to retrieve in a page, between 1 and 1000."
          }
        },
        "required": [
          "count"
        ]
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_list\_reverse\_etlsync\_statuses\_from\_model\_and\_subscription\_id

List Reverse ETL Sync Statuses from Model And Subscription Id

**Parameters:**

| Parameter        | Type   | Required | Default | Description                                                                                                                         |
| ---------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `modelId`        | string | Yes      | —       | Model Id                                                                                                                            |
| `subscriptionId` | string | Yes      | —       | Subscription Id                                                                                                                     |
| `count`          | number | No       | —       | The number of items to retrieve in a page, between 1 and 100. Default is 10  This parameter exists in alpha.                        |
| `cursor`         | string | No       | —       | The page to request. Acceptable values to use are from the `current`, `next`, and `previous` keys.  This parameter exists in alpha. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "modelId": {
        "type": "string",
        "description": "Model Id"
      },
      "subscriptionId": {
        "type": "string",
        "description": "Subscription Id"
      },
      "count": {
        "type": "number",
        "description": "The number of items to retrieve in a page, between 1 and 100. Default is 10  This parameter exists in alpha."
      },
      "cursor": {
        "type": "string",
        "description": "The page to request. Acceptable values to use are from the `current`, `next`, and `previous` keys.  This parameter exists in alpha."
      }
    },
    "required": [
      "PCID",
      "modelId",
      "subscriptionId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_list\_selective\_syncs\_from\_warehouse\_and\_space

List Selective Syncs from Warehouse And Space

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                                         |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------- |
| `spaceId`     | string | Yes      | —       | Space Id                                                            |
| `warehouseId` | string | Yes      | —       | Warehouse Id                                                        |
| `pagination`  | object | No       | —       | Defines the pagination parameters.  This parameter exists in alpha. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "spaceId": {
        "type": "string",
        "description": "Space Id"
      },
      "warehouseId": {
        "type": "string",
        "description": "Warehouse Id"
      },
      "pagination": {
        "type": "object",
        "description": "Defines the pagination parameters.  This parameter exists in alpha.",
        "properties": {
          "cursor": {
            "type": "string",
            "description": "The page to request.  Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys.  Consumers of the API must treat this value as opaque."
          },
          "count": {
            "type": "integer",
            "description": "The number of items to retrieve in a page, between 1 and 1000."
          }
        },
        "required": [
          "count"
        ]
      }
    },
    "required": [
      "PCID",
      "spaceId",
      "warehouseId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_list\_warehouses

List Warehouses

**Parameters:**

| Parameter    | Type   | Required | Default | Description                                                      |
| ------------ | ------ | -------- | ------- | ---------------------------------------------------------------- |
| `pagination` | object | No       | —       | Defines the pagination parameters.  This parameter exists in v1. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "pagination": {
        "type": "object",
        "description": "Defines the pagination parameters.  This parameter exists in v1.",
        "properties": {
          "cursor": {
            "type": "string",
            "description": "The page to request.  Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys.  Consumers of the API must treat this value as opaque."
          },
          "count": {
            "type": "integer",
            "description": "The number of items to retrieve in a page, between 1 and 1000."
          }
        },
        "required": [
          "count"
        ]
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_remove\_profiles\_warehouse\_from\_space

Remove Profiles Warehouse from Space

**Parameters:**

| Parameter     | Type   | Required | Default | Description  |
| ------------- | ------ | -------- | ------- | ------------ |
| `spaceId`     | string | Yes      | —       | Space Id     |
| `warehouseId` | string | Yes      | —       | Warehouse Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "spaceId": {
        "type": "string",
        "description": "Space Id"
      },
      "warehouseId": {
        "type": "string",
        "description": "Warehouse Id"
      }
    },
    "required": [
      "PCID",
      "spaceId",
      "warehouseId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_remove\_source\_connection\_from\_warehouse

Remove Source Connection from Warehouse

**Parameters:**

| Parameter     | Type   | Required | Default | Description  |
| ------------- | ------ | -------- | ------- | ------------ |
| `warehouseId` | string | Yes      | —       | Warehouse Id |
| `sourceId`    | string | Yes      | —       | Source Id    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "warehouseId": {
        "type": "string",
        "description": "Warehouse Id"
      },
      "sourceId": {
        "type": "string",
        "description": "Source Id"
      }
    },
    "required": [
      "PCID",
      "warehouseId",
      "sourceId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_update\_profiles\_warehouse\_for\_space\_warehouse

Update Profiles Warehouse for Space Warehouse

**Parameters:**

| Parameter     | Type    | Required | Default | Description                                                                                                                                                                                                                                                                                                                                                                                      |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `spaceId`     | string  | Yes      | —       | Space Id                                                                                                                                                                                                                                                                                                                                                                                         |
| `warehouseId` | string  | Yes      | —       | Warehouse Id                                                                                                                                                                                                                                                                                                                                                                                     |
| `enabled`     | boolean | No       | —       | Enable to allow this Warehouse to receive data. Defaults to true.                                                                                                                                                                                                                                                                                                                                |
| `name`        | string  | No       | —       | An optional human-readable name for this Warehouse.                                                                                                                                                                                                                                                                                                                                              |
| `schemaName`  | string  | No       | —       | The custom schema name that Segment uses on the Warehouse side. The space slug value is default otherwise.                                                                                                                                                                                                                                                                                       |
| `settings`    | object  | No       | —       | A key-value object that contains instance-specific settings for a Warehouse.  Different kinds of Warehouses require different settings. The required and optional settings for a Warehouse are described in the `options` object of the associated Warehouse metadata.  You can find the full list of Warehouse metadata and related settings information in the `/catalog/warehouses` endpoint. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "spaceId": {
        "type": "string",
        "description": "Space Id"
      },
      "warehouseId": {
        "type": "string",
        "description": "Warehouse Id"
      },
      "enabled": {
        "type": "boolean",
        "description": "Enable to allow this Warehouse to receive data. Defaults to true."
      },
      "name": {
        "type": "string",
        "description": "An optional human-readable name for this Warehouse."
      },
      "schemaName": {
        "type": "string",
        "description": "The custom schema name that Segment uses on the Warehouse side. The space slug value is default otherwise."
      },
      "settings": {
        "description": "A key-value object that contains instance-specific settings for a Warehouse.  Different kinds of Warehouses require different settings. The required and optional settings for a Warehouse are described in the `options` object of the associated Warehouse metadata.  You can find the full list of Warehouse metadata and related settings information in the `/catalog/warehouses` endpoint."
      }
    },
    "required": [
      "PCID",
      "spaceId",
      "warehouseId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_update\_reverse\_etl\_model

Update Reverse Etl Model

**Parameters:**

| Parameter               | Type    | Required | Default | Description                                                                                                                                                                    |
| ----------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `modelId`               | string  | Yes      | —       | Model Id                                                                                                                                                                       |
| `description`           | string  | No       | —       | A longer, more descriptive explanation of the Model.                                                                                                                           |
| `enabled`               | boolean | No       | —       | Indicates whether the Model should have syncs enabled. When disabled, no syncs will be triggered, regardless of the enabled status of the attached destinations/subscriptions. |
| `name`                  | string  | No       | —       | A short, human-readable description of the Model.                                                                                                                              |
| `query`                 | string  | No       | —       | The SQL query that will be executed to extract data from the connected Source.                                                                                                 |
| `queryIdentifierColumn` | string  | No       | —       | Indicates the column named in `query` that should be used to uniquely identify the extracted records.                                                                          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "modelId": {
        "type": "string",
        "description": "Model Id"
      },
      "description": {
        "type": "string",
        "description": "A longer, more descriptive explanation of the Model."
      },
      "enabled": {
        "type": "boolean",
        "description": "Indicates whether the Model should have syncs enabled. When disabled, no syncs will be triggered, regardless of the enabled status of the attached destinations/subscriptions."
      },
      "name": {
        "type": "string",
        "description": "A short, human-readable description of the Model."
      },
      "query": {
        "type": "string",
        "description": "The SQL query that will be executed to extract data from the connected Source."
      },
      "queryIdentifierColumn": {
        "type": "string",
        "description": "Indicates the column named in `query` that should be used to uniquely identify the extracted records."
      }
    },
    "required": [
      "PCID",
      "modelId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_update\_selective\_sync\_for\_warehouse\_and\_space

Update Selective Sync for Warehouse And Space

**Parameters:**

| Parameter           | Type      | Required | Default | Description                                                                                                                                     |
| ------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `spaceId`           | string    | Yes      | —       | Space Id                                                                                                                                        |
| `warehouseId`       | string    | Yes      | —       | Warehouse Id                                                                                                                                    |
| `enableEventTables` | boolean   | No       | —       | A flag to enable or disable all event Tables. This field is optional.                                                                           |
| `syncOverrides`     | object\[] | No       | —       | A list of sync Schema overrides to apply to this Space Warehouse. Note: Selective Sync is not supported if the enableEventTables flag is false. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "spaceId": {
        "type": "string",
        "description": "Space Id"
      },
      "warehouseId": {
        "type": "string",
        "description": "Warehouse Id"
      },
      "enableEventTables": {
        "type": "boolean",
        "description": "A flag to enable or disable all event Tables. This field is optional."
      },
      "syncOverrides": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "collection": {
              "type": "string",
              "description": "The collection within the Source."
            },
            "enabled": {
              "type": "boolean",
              "description": "Represents the overridden enabled state for the listed collection and / or properties."
            },
            "property": {
              "type": "string",
              "description": "A map that contains the properties within the collection to which the Warehouse should sync."
            }
          },
          "required": [
            "collection",
            "enabled"
          ]
        },
        "description": "A list of sync Schema overrides to apply to this Space Warehouse. Note: Selective Sync is not supported if the enableEventTables flag is false."
      }
    },
    "required": [
      "PCID",
      "spaceId",
      "warehouseId"
    ]
  }
  ```
</Expandable>

***

## segment\_warehouses\_update\_warehouse

Update Warehouse

**Parameters:**

| Parameter     | Type    | Required | Default | Description                                                                                                                                                                                                                                                                                                                                                                                      |                                                                   |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
| `warehouseId` | string  | Yes      | —       | Warehouse Id                                                                                                                                                                                                                                                                                                                                                                                     |                                                                   |
| `enabled`     | boolean | No       | —       | Enable to allow this Warehouse to receive data.                                                                                                                                                                                                                                                                                                                                                  |                                                                   |
| `name`        | string  | null     | No      | —                                                                                                                                                                                                                                                                                                                                                                                                | An optional human-readable name to associate with this Warehouse. |
| `settings`    | object  | No       | —       | A key-value object that contains instance-specific settings for a Warehouse.  Different kinds of Warehouses require different settings. The required and optional settings for a Warehouse are described in the `options` object of the associated Warehouse metadata.  You can find the full list of Warehouse metadata and related settings information in the `/catalog/warehouses` endpoint. |                                                                   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "warehouseId": {
        "type": "string",
        "description": "Warehouse Id"
      },
      "enabled": {
        "type": "boolean",
        "description": "Enable to allow this Warehouse to receive data."
      },
      "name": {
        "type": [
          "string",
          "null"
        ],
        "description": "An optional human-readable name to associate with this Warehouse."
      },
      "settings": {
        "description": "A key-value object that contains instance-specific settings for a Warehouse.  Different kinds of Warehouses require different settings. The required and optional settings for a Warehouse are described in the `options` object of the associated Warehouse metadata.  You can find the full list of Warehouse metadata and related settings information in the `/catalog/warehouses` endpoint."
      }
    },
    "required": [
      "PCID",
      "warehouseId"
    ]
  }
  ```
</Expandable>