Edit Custom Zone

Production

https://api.polestar-production.com

PUT

/zone-port-insights/v1/zones/custom/{id}

Edit a custom zone definition.

Note that custom circular zones cannot be changed to polygon zones, and
vice versa.

Request

Authorization

API Key

Add parameter in header

api-key

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The updated zone.

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/zone-port-insights/v1/zones/custom/66a6d317-3f38-46c0-b46d-758d3a1ed385' \
--header 'api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "account_id": "1939ef43-72d1-42e7-bce5-cdb215c43dd3",
    "name": "Zone A",
    "description": "A polygon zone",
    "custom_type": "POLYGON",
    "polygon_details": {
        "format": "GeoJson",
        "polygon": "{\"features\":[{\"geometry\":{\"coordinates\":[[[30,20],[40,40],[20,40],[10,20],[30,20]]],\"type\":\"Polygon\"},\"type\":\"Feature\",\"properties\":{}}],\"type\":\"FeatureCollection\"}"
    }
}'

Response Example

200 - The same custom zone after its radius was widened

{
    "meta": {
        "request_id": "9a4e2d71-0c3b-4f58-a6e9-2b7d15c8f3a0",
        "request_timestamp": "2026-09-30T14:03:10Z",
        "zone_version": "0.8.2"
    },
    "data": {
        "id": "7f3c9a2e-4b18-4d6f-9e21-5a8c0d7b3f14",
        "name": "Maasvlakte approach watch",
        "type": "Custom",
        "sub_type": "Custom",
        "description": "Radius widened to eight nautical miles after the pilot station moved",
        "centroid": {
            "longitude": 3.95,
            "latitude": 51.98
        },
        "country_code": "",
        "country_common_name": "",
        "country_official_name": "",
        "sub_division_code": "",
        "sub_division_name": "",
        "unlocode": "",
        "wpi_number": "",
        "custom_type": "CIRCULAR",
        "created_by": "j.harding@example.com",
        "created_at": "2026-09-30T09:12:44Z",
        "last_modified_by": "j.harding@example.com",
        "last_modified_at": "2026-09-30T14:03:10Z",
        "circle_details": {
            "latitude": "51.98",
            "longitude": "3.95",
            "radius": "14816"
        }
    }
}

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

Create Custom Zone

Overview