Skip to main content
Version: Latest

WatchlistMutation

type WatchlistMutation {
  create(
    name: String!
    companyIds: [String!]!
    shared: Boolean!
    userId: Int
    isFavourite: Boolean
    type: WatchlistType
    source: String
  ): Watchlist!
  patch(
    watchlist: UpdateWatchlistInput!
  ): Watchlist!
  addCompanies(
    watchlist: UpdateWatchlistCompaniesInput!
  ): [String!]!
  removeCompanies(
    watchlist: UpdateWatchlistCompaniesInput!
  ): [String!]!
  delete(
    id: Int!
  ): WatchlistMutationResult!
  deleteWatchlists(
    ids: [Int!]!
  ): [Int!]
}

Fields​

WatchlistMutation.create ● Watchlist! non-null object graph-ql-types​

Create a watchlist with the given name and a list of AS ID. @exposed

WatchlistMutation.create.name ● String! non-null scalar graph-ql-types​

Name of the watchlist

WatchlistMutation.create.companyIds ● [String!]! non-null scalar graph-ql-types​

List of company Ids. The company id could be AS ID, ticker code or ISIN.

WatchlistMutation.create.shared ● Boolean! non-null scalar graph-ql-types​

share watchlist with other users

WatchlistMutation.create.userId ● Int scalar graph-ql-types​

Owner of the watchlist, specify if you want to create this watchlist for someone else. Only available for watchlist admins.

WatchlistMutation.create.isFavourite ● Boolean scalar graph-ql-types​

Watchlist favourite status. If true, then user has marked this watchlist as his favourite

WatchlistMutation.create.type ● WatchlistType enum graph-ql-types​

Type of the watchlist: USER, SYSTEM_GENERATED, etc

WatchlistMutation.create.source ● String scalar graph-ql-types​

Source of the watchlist creation: WATCHLIST, COPRO, etc

WatchlistMutation.patch ● Watchlist! non-null object graph-ql-types​

Update the watchlist partially by watchlist ID @exposed

WatchlistMutation.patch.watchlist ● UpdateWatchlistInput! non-null input graph-ql-types​

Watchlist Input

WatchlistMutation.addCompanies ● [String!]! non-null scalar graph-ql-types​

Add new companies to watchlist @exposed

WatchlistMutation.addCompanies.watchlist ● UpdateWatchlistCompaniesInput! non-null input graph-ql-types​

Watchlist id and list of company ids

WatchlistMutation.removeCompanies ● [String!]! non-null scalar graph-ql-types​

Remove companies from watchlist @exposed

WatchlistMutation.removeCompanies.watchlist ● UpdateWatchlistCompaniesInput! non-null input graph-ql-types​

Watchlist id and list of company ids

WatchlistMutation.delete ● WatchlistMutationResult! non-null object graph-ql-types​

Delete watchlist with id @exposed

WatchlistMutation.delete.id ● Int! non-null scalar graph-ql-types​

Watchlist ID

WatchlistMutation.deleteWatchlists ● [Int!] list scalar graph-ql-types​

Bulk mutation to delete watchlists by ids. It returns the ids of the successfully deleted watchlists. @exposed

WatchlistMutation.deleteWatchlists.ids ● [Int!]! non-null scalar graph-ql-types​

Returned By​

watchlist mutation