updateSmartList
Idempotent
Update an existing smart list by ID to modify filter criteria or schedule without affecting other fields.
Instructions
Update a smart list - Update an existing smartlist record by ID. Fields omitted are untouched. Writes live data.
Use when: editing the filter criteria or schedule on a saved list.
Required: smart_list_id.
See also: createSmartList (add new), deleteSmartList (remove permanently).
Returns: { status: "success", message: {...updatedRecord} } - the full updated record after changes applied.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| smart_list_id | Yes | ||
| smart_list_name | No | ||
| smart_list_modified_by | No | ||
| smart_list_query_params | No | Filter criteria — format depends on `smart_list_type`: - **newsletter** - pass a URL string (used directly as `href`) - **all other types** (members, leads, reviews, transaction, forms_inbox) - pass a JSON string of key-value filter pairs like `{"subscription_id":"1","active":"1"}` - **no filters** - pass `"NA"` Backend encrypts internally - do NOT pre-encrypt client-side. | |
| schedule | No | Recurrence frequency | |
| _clear_fields | No | Column names to clear to empty string. Available on every `update*` operation. Works on base columns AND EAV/`users_meta` rows (rows preserved with `value=""`). To actually clear a field you MUST use this parameter — sending the field with `""` alone is a no-op (BD drops empty values). To remove a `users_meta` row entirely, use `deleteUserMeta`. See **Rule: Clearing fields**. Example: `_clear_fields: ["h2", "hero_link_url"]`. |