Arguments

Name	Type	Description
id	ObjectId!	The VOI list's unique Windward-assigned ID whose settings are updated.
voi	VOIInput!	Sets the updated values of the Vessel of Interest (VOI) list.

VOIInput Fields

Name	Type	Description
color	String	The color with which the VOI is highlighted in WindWard UI.
name	String	The VOI list name.
notifications	NotificationsInput	Sets the VOI notification settings.

Returns

Name	Description
VOI	The updated Vessel of Interest list name and ID.

VOI Fields

Name	Type	Description
id	ObjectId	The unique Windward assigned ID of the updated VOI.
name	String	The name of the updated VOI.

Example Code

Sample Mutation

mutation UpdateVoi($updateVoiId: ObjectId!, $voi: VOIInput!) {
  updateVoi(id: $updateVoiId, voi: $voi) {
    id
    name
  }
}

Variables

{
  "updateVoiId": "63a85d960f405d00118239ea",
  "voi": {
    "notifications": {
      "compliance": {
        "appNotifications": true
      }
    }
  }
}

Response

{
  "data": {
    "updateVoi": {
      "id": "63a85d960f405d00118239ea",
      "name": "New-VOI"
    }
  }
}