Create a list
create_listCreate a list. To set up several lists with indexes and rules, a schema sync document (plan_schema_sync, apply_schema_sync) is usually better. Rules that don't compile, or whose tests fail, refuse the whole create, with diagnostics in details. 1 request.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The list's name | |
| tags | No | Tags (at most 20). Replaces the existing tags | |
| rules | No | Write rules, in the JSONPad rules language, checked on every item write made with an API token; null removes them. Check them first with the JSONPad docs server's check_write_rules | |
| pinned | No | ||
| schema | No | A JSON schema every item's data must match, or null for none | |
| pathName | No | A unique name to use in URLs instead of the id (letters, digits, - and _) | |
| readonly | No | Refuse writes to the list, its items and indexes | |
| realtime | No | Send realtime events for the list's changes | |
| activated | No | Deactivated lists are invisible to tokens | |
| indexable | No | Allow listing and searching its items with a token. A new list is not indexable unless this is set | |
| protected | No | Refuse to delete the list while it has items | |
| rulesTests | No | Tests the rules must pass before they're saved, or null for none | |
| description | No | What the list is for |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| list | Yes | ||
| ruleWarnings | No |