updateRoutePlanningSettings

Requires permission visits:journey-plan:manage.

Changes the organization's route planning rules. Only the rules sent change. The merged rules are checked together: for example, a plan must reach the next automatic run, and rebuilding cannot run daily. Requires permission to manage journey plans.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation UpdateRoutePlanningSettings($input: UpdateRoutePlanningSettingsInput!) {
  updateRoutePlanningSettings(input: $input) {
    daysOff
    defaultVisitFrequencyDays
    isDefault
    keepManualStops
    maxSameDayRadiusKm
    minutesPerVisit
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateRoutePlanningSettings($input: UpdateRoutePlanningSettingsInput!) {\n  updateRoutePlanningSettings(input: $input) {\n    daysOff\n    defaultVisitFrequencyDays\n    isDefault\n    keepManualStops\n    maxSameDayRadiusKm\n    minutesPerVisit\n  }\n}",
  "variables": {
    "input": {}
  }
}
EOF

Variables:

{
  "input": {}
}

Response:

{
  "data": {
    "updateRoutePlanningSettings": {
      "daysOff": [
        "string"
      ],
      "defaultVisitFrequencyDays": 0,
      "isDefault": true,
      "keepManualStops": true,
      "maxSameDayRadiusKm": 0,
      "minutesPerVisit": 0
    }
  }
}

updateRoutePlanningSettings(
  input: UpdateRoutePlanningSettingsInput!
): RoutePlanningSettings!

Arguments

updateRoutePlanningSettings.input ● UpdateRoutePlanningSettingsInput! non-null input

The rules to change.

Type

RoutePlanningSettings object

The organization's route planning rules, with the values worked out from them.