Edit Zone & Port Notification Subscription

Production

https://api.polestar-production.com

PUT

/notifications/v1/zones-and-ports/{id}

Update an area subscription in place. Use this to edit any configuration
setting, and to activate or deactivate the subscription. Part of both
Port & Trade and Domain & Fleet.

Request

Authorization

API Key

Add parameter in header

api-key

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Zone and port notification subscription updated. Returns the updated zone and port 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/zones-and-ports/1c60546c-da9d-425c-8eed-0142af219601' \
--header 'api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "active": true,
    "custom_reference": "OPS-ROTTERDAM-114",
    "name": "Rotterdam port call watch",
    "description": "Entry and exit alerts for the Rotterdam port area, now including berth arrivals",
    "settings": {
        "email_settings": {
            "email_enabled": true,
            "scheduler": {
                "schedule_type": 1,
                "at_time": "12:00"
            }
        },
        "notification_callback_url": "https://webhooks.example.com/event-notifications",
        "filters": {
            "event_types": [
                "ZONE_ENTRY",
                "ZONE_EXIT"
            ],
            "vessels": [
                "9074729"
            ],
            "zones_ports": [
                "5e98acb5-4b8a-451b-9280-ddd63d55f8c9"
            ]
        }
    }
}'

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": "OPS-ROTTERDAM-114",
    "subscription_id": "5e98acb5-4b8a-451b-9280-ddd63d55f8c9",
    "last_modified_at": "2026-09-07T09:42:11Z",
    "description": "Entry and exit alerts for the Rotterdam port area, now including berth arrivals",
    "name": "Rotterdam port call watch",
    "settings": {
        "notification_callback_url": "https://webhooks.example.com/event-notifications",
        "email_settings": {
            "email_enabled": true,
            "scheduler": {
                "schedule_type": 1,
                "at_time": "12:00"
            }
        }
    }
}

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

Get Zone & Port Notification Subscriptions

Delete Zone & Port Notification Subscription