createVoi

Creates a Vessel of Interest List (VOI).

A VOI list can include up to 4000 vessels. Organizations may create and manage multiple VOI lists.

Arguments

NameTypeDescription
nameString!The name of the New Vessel of interest list.
colorStringThe color with which the VOI is highlighted in WindWard UI.

Returns

NameDescription
VOIThe created Vessel Of Interest list name and ID.

VOI Fields

NameTypeDescription
idObjectIdThe unique Windward assigned ID of the VOI
nameStringName of the Vessel Of Interest list.

Example Code

Sample Mutation

mutation CreateVoi($name: String!, $color: String) {
  createVoi(name: $name, color: $color) {
    id
    name
  }
}

Variables

{
  "name": "New-VOI",
  "color": "Blue"
}

Response

{
  "data": {
    "createVoi": {
      "id": "63a84e070f405d00118234fd",
      "name": "New-VOI"
    }
  }
}