Create Planned Route Identifier

Create a title that can be selected or automatically assigned as the name for a new planned route in Bringg.

When you create planned route identifiers, Bringg automatically assigns an identifier to new planned routes during route optimization. If you assign a planned route identifier id or external_id to the new planned route, Bringg will use that identifier as the route name. Otherwise, Bringg automatically names the route using the planned route identifier whose priority matches the route's place in the day's sequence of departures.

For example, during route optimization, if a planned route has the earliest departure time and isn't assigned a specific planned route identifier id or external_id, it is automatically assigned to the planned route identifier that includes the priority level 1.

Bringg does not use default planned route identifiers.

This API supports a single record per call. A title is required and must be unique per team.

Response (Output) Params

Parameter

Description

*success**
boolean

Indicates whether the service completed successfully.

  • false* - the service failed.
  • true* - the service succeeded

*message**
string

If an error occurred, a message indicating the error is included.

*rc**
integer

If an error occurred, the return code is included.

*created_at**
datetime

The timestamp when the user was created. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".

*external_id**
string

Your system's ID for this planned route identifier.

*external_team_id**
string

Your system's ID for the team to which this planned route identifier is assigned.

*id**
integer

The Bringg ID for this planned route identifier.

*priority**
integer

Indicates the hierarchy among your route identifiers. The route identifier with the highest priority receives the route scheduled to leave first.

*team_id**
integer

Bringg's ID for the team to which this planned route identifier is assigned.

*title**
string

The title of the planned route identifier as it appears in the Bringg UI (for example, in the Route Name column).

*updated_at**
datetime

The last date and time this team was updated. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".

Language