updateVoi

Changes the notification settings of specified Vessel of Interest list alerts.

Arguments

NameTypeDescription
idObjectId!The VOI list's unique Windward-assigned ID whose settings are updated.
voiVOIInput!Sets the updated values of the Vessel of Interest (VOI) list.

VOIInput Fields

NameTypeDescription
colorStringThe color with which the VOI is highlighted in WindWard UI.
nameStringThe VOI list name.
notificationsNotificationsInputSets the VOI notification settings.

Returns

NameDescription
VOIThe updated Vessel of Interest list name and ID.

VOI Fields

NameTypeDescription
idObjectIdThe unique Windward assigned ID of the updated VOI.
nameStringThe 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"
    }
  }
}