Update a planning config
PATCH /v1/planning_configs/{id}
Changes the fields you send.
Authentication
Send a token issued in the Zoopit dashboard as Authorization: Bearer <token>.
Path parameters
| Name | Type | Required |
|---|---|---|
id | string | yes |
Request body
| Field | Type | Required |
|---|---|---|
sort_type | "delivery" | "pickup" or null | |
sort_by | null or string | |
objectives | array of Objective | |
auto_save_routes | boolean | |
name | string | |
with_traffic_eta | boolean | |
ignore_sorting | null or boolean | |
ignore_skills | null or boolean | |
ignore_capacity | null or boolean | |
ignore_driver_shifts | null or boolean | |
ignore_pickup_window | null or boolean | |
ignore_delivery_window | null or boolean | |
modified_at | null or string | |
tags | array of string | |
attributes | object |
Responses
200
resource: PlanningConfig
| Field | Type | Required |
|---|---|---|
sort_type | "delivery" | "pickup" or null | yes |
sort_by | null or string | yes |
objectives | array of Objective | yes |
auto_save_routes | boolean | yes |
name | string | yes |
with_traffic_eta | boolean | yes |
ignore_sorting | null or boolean | yes |
ignore_skills | null or boolean | yes |
ignore_capacity | null or boolean | yes |
ignore_driver_shifts | null or boolean | yes |
ignore_pickup_window | null or boolean | yes |
ignore_delivery_window | null or boolean | yes |
id | string | yes |
created_at | string | yes |
modified_at | null or string | yes |
deleted_at | null or string | yes |
created_by | string | yes |
modified_by | null or string | yes |
deleted_by | null or string | yes |
owners | array of string | yes |
tags | array of string | yes |
attributes | object | yes |
Example
curl -X PATCH 'https://routes-api.cloud.zoopit.no/v1/planning_configs/{id}'
-H 'Authorization: Bearer <token>'
-H 'Content-Type: application/json'
-d '{ ... }'
Try it in the interactive Routes API reference.
Field descriptions, guides and worked examples are in the full reference, available to customers in the Zoopit dashboard under Accounts → Developer.