466169815b78
Create a new collection
Create a new collection with the specified properties.
The collection will be created with "Customer" scope by default unless explicitly specified otherwise. All required fields must be provided and will be validated.
Note: The collection will be automatically subscribed to your account upon creation, and you will become the collection owner.
Request: The request body includes collection name (required) and optional fields for scope, lanes, tiersEnabled, and parentId. See the PublicCollectionPayload schema for complete field definitions and validation rules.
Validation Rules:
- Collection names must be unique within the specified scope
- The tiersEnabled field cannot be changed after collection creation
- The parentId field is accepted but currently not used - collection hierarchy is managed internally
What happens when you create a collection:
- Collection Creation: A new active collection is created with the specified properties
- User Subscription: You are automatically subscribed to the collection and become its owner
- User Activity: For Customer scope collections, the creation is logged in your user activity
- Audit Trail: The creation is recorded in the audit log with:
- The user who created the collection
- Timestamp of the operation
- Collection details (name, scope, type)
- Reference to the public API endpoint used
- Audit comment: "Collection created via Public API"
Important Notes:
- Collection names must be unique within the specified scope - attempting to use a duplicate name will result in 409 Conflict
- Once created, the scope and tiersEnabled fields cannot be changed
- The collection will be empty (no targets) initially - use the Collection Targets API (POST /public/v1/collections/{collectionId}/targets) to add suppliers to the collection
- You automatically become the owner of the collection upon creation
- All collection operations are audited for compliance and tracking purposes
Required Permission: CREATE_COLLECTION
Request body
Response
201 Created - Collection created successfully. The creation has been audited with the comment 'Collection created via Public API'.