Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

itemId

string

eventId

Bookmarks a schedule item for a currently logged-in member.

import { scheduleBookmarks } from 'wix-events.v2';

async function createBookmark(itemId, eventId) {
  try {
    const result = await scheduleBookmarks.createBookmark(itemId, eventId);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


createBookmark example

import { scheduleBookmarks } from 'wix-events.v2';
import { webMethod, Permissions } from 'wix-web-module';

export const createBookmark = webMethod(
  Permissions.Anyone,
  async (itemId, eventId) => {
    try {
      const result = await scheduleBookmarks.createBookmark(itemId, eventId);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


createBookmark example for exporting from backend code

createBookmark

void

Removes a schedule item bookmark for a currently logged-in member.

import { scheduleBookmarks } from 'wix-events.v2';

async function deleteBookmark(itemId, eventId) {
  try {
    const result = await scheduleBookmarks.deleteBookmark(itemId, eventId);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


deleteBookmark example

import { scheduleBookmarks } from 'wix-events.v2';
import { webMethod, Permissions } from 'wix-web-module';

export const deleteBookmark = webMethod(
  Permissions.Anyone,
  async (itemId, eventId) => {
    try {
      const result = await scheduleBookmarks.deleteBookmark(itemId, eventId);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


deleteBookmark example for exporting from backend code

deleteBookmark

Retrieves a list of bookmarked schedule items for a currently logged-in member.

import { scheduleBookmarks } from 'wix-events.v2';

async function listBookmarks(eventId) {
  try {
    const result = await scheduleBookmarks.listBookmarks(eventId);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


listBookmarks example

import { scheduleBookmarks } from 'wix-events.v2';
import { webMethod, Permissions } from 'wix-web-module';

export const listBookmarks = webMethod(
  Permissions.Anyone,
  async (eventId) => {
    try {
      const result = await scheduleBookmarks.listBookmarks(eventId);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


listBookmarks example for exporting from backend code

listBookmarks

ListBookmarksResponse

---
title: Introduction
---
# Introduction

> **Note**: This module is [universal](/api-overview/api-versions#universal-modules). Functions in this module can run on both the backend and frontend, unless specified otherwise.

With the Schedule Bookmarks API you can allow members to mark their favorite [schedule items](https://dev.wix.com/docs/velo/api-reference/wix-events-v2/schedule/introduction) to curate their own personalized agenda for your event.    

With the Schedule Bookmarks API you can:

- Create and delete bookmarks.
- List all bookmarks per member.

## Before you begin

It’s important to note the following points before starting to code:  

- Install the **Wix Events & Tickets** app from [Wix App Market](https://www.wix.com/app-market/wix-events?referral=category&appIndex=5&referralTag=booking--events).
- To use the Schedule Bookmarks API, import `{ scheduleBookmarks }` from the `wix-events.v2` module:

```javascript
import { scheduleBookmarks } from 'wix-events.v2';
```

## Terminology

- **Schedule**: A structured plan or timetable that outlines the sequence of activities, presentations, performances, or sessions scheduled to occur during an event.
- **Event**: A gathering organized by an individual or business for a group of people.


velo-deps_wix-events.v2_schedule-bookmarks

items

ScheduleItem

Date and time when the schedule item was created.

_createdDate

Date and time when the schedule item was updated.

_updatedDate

description

draft

boolean

Whether a schedule item is hidden from guests.

hidden

name

Stage or room name in which the session takes place.

stageName

Schedule item status. Possible values:
- `SCHEDULED`: An item is scheduled.
- `CANCELED`: An item is canceled.

status

ScheduleStatus

Schedule item tags. They're used to organize the items to a theme.

timeSlot

TimeInterval

start

Time zone ID in the [TZ database](https://www.iana.org/time-zones) format. For example, `EST`, `America/Los_Angeles`.
Default: `Etc/UTC`.

deleteBookmark( )