Skip to content

Create a saved view default

Platform module

POST/saved-view-defaultssavedViewDefaults.create

The saved view the caller opens by default on a page (0641): one per member and collection. Creating one replaces the earlier default of the page (app.set_saved_view_default). Creates a saved view default. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability me.preferences.write.
  • OAuth scopes: me.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: SavedViewDefaultCreate

savedViewDefaults.create: SavedViewDefaultCreate
FieldTypeRequiredDescription
saved_view_idstring (uuid)YesIdentifier of the saved view the caller can read, of the same collection.
{
  "saved_view_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 201: SavedViewDefault

savedViewDefaults.create: SavedViewDefault
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the saved view default.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row.
membership_idstring (uuid)YesIdentifier of the membership of the caller, set by the server.
collection_keystringYesCollection (page) the default applies to, as saved views name it.Constraints: pattern ^[a-z][a-z0-9_]*(\/[a-z][a-z0-9_]*)?$
saved_view_idstring (uuid)YesIdentifier of the saved view the caller can read, of the same collection.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "collection_key": "logistics/shipments",
  "saved_view_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X POST "$XOS_BASE_URL/saved-view-defaults" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"saved_view_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.savedViewDefaults.create({
    "saved_view_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.saved_view_defaults.create({"saved_view_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos saved-view-defaults create --data '{"saved_view_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'