POST

Create Data Collection


Creates a new data collection.

The request body must include an ID, details for at least 1 field, and a permissions object. If any of these are missing, the collection isn't created.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Data Collections
Manage All Data Resources
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/wix-data/v2/collections

Body Params
collectionCollectionRequired

Collection details.

Response Object
collectionCollection

Details of collection created.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/wix-data/v2/collections' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ --d '{ "id": "my-first-collection", "displayName": "My First Collection", "fields": [ { "key": "name", "displayName": "First Name", "type": "TEXT" }, { "key": "age", "displayName": "Age", "type": "NUMBER" } ] }'
Response
JSON
{ "collection": { "id": "my-first-collection", "collectionType": "NATIVE", "displayName": "My First Collection", "displayField": "name", "capabilities": { "dataOperations": [ "AGGREGATE", "BULK_INSERT", "BULK_REMOVE", "BULK_SAVE", "BULK_UPDATE", "COUNT", "DISTINCT", "FIND", "GET", "INSERT", "INSERT_REFERENCE", "IS_REFERENCED", "QUERY_REFERENCED", "REMOVE", "REMOVE_REFERENCE", "REPLACE_REFERENCES", "SAVE", "TRUNCATE", "UPDATE" ], "collectionOperations": ["UPDATE", "REMOVE"] }, "fields": [ { "key": "name", "displayName": "First Name", "type": "TEXT", "systemField": false, "capabilities": { "sortable": true, "queryOperators": [ "EQ", "LT", "GT", "NE", "LTE", "GTE", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "HAS_SOME", "HAS_ALL", "EXISTS", "URLIZED" ] }, "encrypted": false }, { "key": "age", "displayName": "Age", "type": "NUMBER", "systemField": false, "capabilities": { "sortable": true, "queryOperators": [ "EQ", "LT", "GT", "NE", "LTE", "GTE", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "HAS_SOME", "HAS_ALL", "EXISTS", "URLIZED" ] }, "encrypted": false }, { "key": "_id", "displayName": "ID", "type": "TEXT", "systemField": true, "capabilities": { "sortable": true, "queryOperators": [ "EQ", "LT", "GT", "NE", "LTE", "GTE", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "HAS_SOME", "HAS_ALL", "EXISTS", "URLIZED" ] }, "encrypted": false }, { "key": "_owner", "displayName": "Owner", "type": "TEXT", "systemField": true, "capabilities": { "sortable": true, "queryOperators": [ "EQ", "LT", "GT", "NE", "LTE", "GTE", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "HAS_SOME", "HAS_ALL", "EXISTS", "URLIZED" ] }, "encrypted": false }, { "key": "_createdDate", "displayName": "Created Date", "type": "DATETIME", "systemField": true, "capabilities": { "sortable": true, "queryOperators": [ "EQ", "LT", "GT", "NE", "LTE", "GTE", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "HAS_SOME", "HAS_ALL", "EXISTS", "URLIZED" ] }, "encrypted": false }, { "key": "_updatedDate", "displayName": "Updated Date", "type": "DATETIME", "systemField": true, "capabilities": { "sortable": true, "queryOperators": [ "EQ", "LT", "GT", "NE", "LTE", "GTE", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "HAS_SOME", "HAS_ALL", "EXISTS", "URLIZED" ] }, "encrypted": false } ], "permissions": { "insert": "ADMIN", "update": "ADMIN", "remove": "ADMIN", "read": "ADMIN" }, "revision": "1", "plugins": [], "pagingModes": ["OFFSET"], "createdDate": "2022-09-19T15:10:56.603Z", "updatedDate": "2022-09-19T15:10:56.603Z" } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?