routePlanningRepDay

Requires permission visits:journey-plan:manage.

Returns one rep's day: the live stops with their shown status and who added each, the stops removed from the day with the reason and whether they can be restored, and the day's changes. The rep must be in the caller's team. 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

query RoutePlanningRepDay($date: DateTime!, $repId: ID!) {
  routePlanningRepDay(date: $date, repId: $repId) {
    salesRepName
    date
    journeyPlanId
    notes
    salesRepId
    timeZone
    changes {
      id
      actorName
      partnerName
      reassignedByName
      reassignedToRepName
      salesRepName
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query RoutePlanningRepDay($date: DateTime!, $repId: ID!) {\n  routePlanningRepDay(date: $date, repId: $repId) {\n    salesRepName\n    date\n    journeyPlanId\n    notes\n    salesRepId\n    timeZone\n    changes {\n      id\n      actorName\n      partnerName\n      reassignedByName\n      reassignedToRepName\n      salesRepName\n    }\n  }\n}",
  "variables": {
    "date": "2025-01-15T00:00:00Z",
    "repId": "id"
  }
}
EOF

Variables:

{
  "date": "2025-01-15T00:00:00Z",
  "repId": "id"
}

Response:

{
  "data": {
    "routePlanningRepDay": {
      "salesRepName": "string",
      "date": "2025-01-15T00:00:00Z",
      "journeyPlanId": "string",
      "notes": "string",
      "salesRepId": "id",
      "timeZone": "string",
      "changes": [
        {
          "id": "id",
          "actorName": "string",
          "partnerName": "string",
          "reassignedByName": "string",
          "reassignedToRepName": "string",
          "salesRepName": "string"
        }
      ]
    }
  }
}

routePlanningRepDay(
  date: DateTime!
  repId: ID!
): RoutePlanningRepDay!

Arguments

routePlanningRepDay.date ● DateTime! non-null scalar

The day.

routePlanningRepDay.repId ● ID! non-null scalar

The ID of the sales rep.

Type

RoutePlanningRepDay object

A rep's day: its stops, the stops removed from it, and its changes.