--- title: "Update tier-n collection settings" method: PUT path: "/public/v1/collections/{collectionId}/tier-n/settings" tags: ["Collections - Tier-N"] --- # Update tier-n collection settings `PUT /public/v1/collections/{collectionId}/tier-n/settings` ## Request - Base URL: `https://api.prewave.com` - URL: `https://api.prewave.com/public/v1/collections/{collectionId}/tier-n/settings` - Auth: API key in header `X-Auth-Token` - TypeScript: (a function with typed inputs; its response is checked against the schema) ### Overview Update tier-n configuration for a collection. All request fields are optional (partial update). Updated settings become defaults for `GET .../tier-n/data`. ### Validation - Collection must exist, be active, and have `tiersEnabled=true`. - `maxTier` 1–9 if provided; `probability` 0–100 if provided; dates in YYYY-MM-DD; `shipmentsPeriodFrom` ≤ `shipmentsPeriodTo`. ### Audit The update is recorded with comment "Tier-n collection settings updated via Public API". ### Required Permission `manage_collection` and `update` on the collection. ## Path parameters - `collectionId` integer, required ## Request body - PublicTierNCollectionSettingsUpdateRequest: Request payload for updating tier-n collection settings. This class contains the configuration settings that can be updated for a tier-n enabled collection. All fields are optional, allowing partial updates of the collection settings. ## Configuration Categories ### Tier Configuration - `maxTier`: Maximum tier level for analysis (1-9) ### Scope Settings - `scopePrivate/Shared/Public`: Which target types to include in analysis ### Data Source Settings - `source*`: Which data sources to use for relationship discovery ### Filtering Parameters - `minShipments`: Minimum shipment count threshold - `probability`: Minimum confidence threshold for predictions - `shipmentsPeriodFrom/To`: Time period for shipment analysis - `suspectedSuppliers`: Include suspected suppliers (deprecated; ignored when the new commodity filter is enabled) - `logisticsProvider`: Include logistics service providers - `maxTier` integer, nullable: Maximum tier level configured for analysis. Range: 1-9. Higher values allow deeper supply chain analysis but may increase response time. - `scopePrivate` boolean, nullable: Whether to include private targets in the analysis scope. Private targets typically represent internal company data. - `scopeShared` boolean, nullable: Whether to include shared targets in the analysis scope. Shared targets typically represent partner/team data. - `scopePublic` boolean, nullable: Whether to include public targets in the analysis scope. Public targets typically represent open/public data. - `sourceCustomer` boolean, nullable: Whether to include customer data sources in the analysis. Customer data comes from customer-provided information. - `sourceCustoms` boolean, nullable: Whether to include customs data sources in the analysis. Customs data is typically the most reliable source based on shipment records. - `sourceMedia` boolean, nullable: Whether to include media data sources in the analysis. Media data comes from news reports and may be less reliable. - `sourcePrewavePrediction` boolean, nullable: Whether to include Prewave prediction data sources in the analysis. These are AI-predicted relationships with confidence scores. - `minShipments` integer, nullable: Minimum number of shipments required for a relationship to be included. Higher values filter out less established relationships. Set to null to remove minimum. - `probability` integer, nullable: Minimum probability threshold for predicted relationships (0-100). Higher values return only high-confidence predictions. Set to null to remove threshold. - `shipmentsPeriodFrom` string, date, nullable: Start date for shipment period analysis. Only relationships with shipments in this period are considered. Format: YYYY-MM-DD. Set to null to remove start date limit. - `shipmentsPeriodTo` string, date, nullable: End date for shipment period analysis. Only relationships with shipments in this period are considered. Format: YYYY-MM-DD. Set to null to remove end date limit. - `suspectedSuppliers` boolean, nullable: Deprecated. Whether to include suspected suppliers. Ignored, and suspected suppliers are always turned off, when the new commodity filter is enabled for your organization, which will become the default for all organizations. - `logisticsProvider` boolean, nullable: Whether to include logistics providers in the analysis. Logistics providers are companies that provide logistics services rather than direct suppliers. ## Response `200` Tier-n collection settings updated successfully. - PublicTierNCollectionSettings: Tier-n collection settings and metadata configuration. - `collectionId` integer, required: Unique identifier of the collection. Use this ID in API requests to reference this specific collection. - `collectionName` string, required: Human-readable name of the collection. Useful for display purposes and identifying the collection in logs. - `maxTier` integer, required: Maximum tier level configured for analysis. Range: 1-9. Higher values allow deeper supply chain analysis but may increase response time. - `targetIds` integer[], required: List of target IDs included in this collection. These are the starting points for tier-n analysis. - `scopePrivate` boolean, required: Whether to include private targets in the analysis scope. Private targets typically represent internal company data. - `scopeShared` boolean, required: Whether to include shared targets in the analysis scope. Shared targets typically represent partner/team data. - `scopePublic` boolean, required: Whether to include public targets in the analysis scope. Public targets typically represent open/public data. - `sourceCustomer` boolean, required: Whether to include customer data sources in the analysis. Customer data comes from customer-provided information. - `sourceCustoms` boolean, required: Whether to include customs data sources in the analysis. Customs data is typically the most reliable source based on shipment records. - `sourceMedia` boolean, required: Whether to include media data sources in the analysis. Media data comes from news reports and may be less reliable. - `sourcePrewavePrediction` boolean, required: Whether to include Prewave prediction data sources in the analysis. These are AI-predicted relationships with confidence scores. - `minShipments` integer, nullable: Minimum number of shipments required for a relationship to be included. Higher values filter out less established relationships. Null means no minimum. - `probability` integer, nullable: Minimum probability threshold for predicted relationships (0-100). Higher values return only high-confidence predictions. Null means no threshold. - `shipmentsPeriodFrom` string, date, nullable: Start date for shipment period analysis. Only relationships with shipments in this period are considered. Format: YYYY-MM-DD. Null means no start date limit. - `shipmentsPeriodTo` string, date, nullable: End date for shipment period analysis. Only relationships with shipments in this period are considered. Format: YYYY-MM-DD. Null means no end date limit. - `suspectedSuppliers` boolean, required: Deprecated. Whether suspected suppliers are included. Always false when the new commodity filter is enabled for your organization, which will become the default for all organizations. - `logisticsProvider` boolean, required: Whether to include logistics providers in the analysis. Logistics providers are companies that provide logistics services rather than direct suppliers. - `commodityFilterTargetIds` integer[], required: List of target IDs used for commodity-based filtering. These targets help focus the analysis on specific commodity categories. ## Other responses - `400`: Not tier-n enabled, invalid payload, maxTier/probability out of range, or invalid dates. - `403`: 403 Forbidden - Authentication or authorization failure. This status code is returned when: (1) the request lacks valid authentication credentials (missing or invalid X-Auth-Token header), or (2) the authenticated user does not have the required permission to access this resource. - `404`: Collection not found, inactive, not tier-n enabled, or no UPDATE permission. - `429`: 429 Too Many Requests - API rate limit exceeded. The request has been rejected because the rate limit for this endpoint has been exceeded. Default rate limits: GET requests - 100 per 10 seconds, 500 per minute; POST/PUT/PATCH/DELETE requests - 20 per 10 seconds, 100 per minute. For increased access, please contact customer success. - `500`: 500 Internal Server Error - An unexpected error occurred on the server. The request may or may not have been processed. ## Changes - **2026-10-30** `ecd3f30c3c00`: 2 info - request property `suspectedSuppliers` deprecated - response property `suspectedSuppliers` deprecated [Operation history](https://skmtc.dev/prewave/apis/public-prewave-api/changes/public/v1/collections/:collectionId/tier-n/settings/put.md) --- [API](https://skmtc.dev/prewave/apis/public-prewave-api.md) - [All operations](https://skmtc.dev/prewave/apis/public-prewave-api/llms.txt) - [OpenAPI document](https://skmtc.dev/prewave/apis/public-prewave-api/revisions/bd063a0703c0?raw)