Edit Vessel Notification Subscription

Production

https://api.polestar-production.com

PUT

/notifications/v1/vessels/{id}

Update a vessel subscription in place. Use this to edit any configuration
setting, and to activate or deactivate the subscription.

Request

Authorization

API Key

Add parameter in header

api-key

Example:

api-key: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Vessel notification subscription updated. Returns the updated vessel notification subscription.

Headers

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409

🟠422Parameter Error

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.polestar-production.com/notifications/v1/vessels/5e98acb5-4b8a-451b-9280-ddd63d55f8c9' \
--header 'api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "active": true,
    "custom_reference": "FLEET-OPS-2141",
    "description": "Zone entry and exit alerts for vessels transiting the Panama Canal, now including anchorage waits",
    "name": "Panama Canal transit and anchorage watch",
    "settings": {
        "email_settings": {
            "email_enabled": true,
            "scheduler": {
                "schedule_type": 24,
                "at_time": "10:10"
            }
        },
        "notification_callback_url": "https://webhooks.example.com/event-notifications",
        "imo": "9074729",
        "filters": {
            "zones": {
                "type": "zones",
                "active": true,
                "event_types": [
                    "ZONE_ENTRY",
                    "ZONE_EXIT"
                ],
                "zone_ids": [
                    "5e98acb5-4b8a-451b-9280-ddd63d55f8c9"
                ],
                "zone_types": [
                    "Jurisdictional"
                ],
                "zone_sub_types": [
                    "Internal Waters"
                ]
            }
        }
    }
}'

Response Example

201 - The subscription as it stands after the update

{
    "active": true,
    "callback_url_status": "ok",
    "created_at": "2026-08-12T10:15:30Z",
    "created_by": "user@example.com",
    "custom_reference": "FLEET-OPS-2141",
    "subscription_id": "5e98acb5-4b8a-451b-9280-ddd63d55f8c9",
    "last_modified_at": "2026-09-07T09:42:11Z",
    "description": "Zone entry and exit alerts for vessels transiting the Panama Canal, now including anchorage waits",
    "name": "Panama Canal transit and anchorage watch",
    "settings": {
        "notification_callback_url": "https://webhooks.example.com/event-notifications",
        "imo": "9074729",
        "email_settings": {
            "email_enabled": true,
            "scheduler": {
                "schedule_type": 24,
                "at_time": "10:10"
            }
        }
    }
}

Modified at 2026-10-19 12:14:24

Get Vessel Notification Subscription

Get Vessel Notifications by Subscription ID