Segments
The ordered legs a route is made of. A segment is routed along real trails or drawn freehand, and the operations here are the ones that change the shape of a route: insert, split, merge, reorder, and switch a leg between routed and freehand.
/v1/itineraries/{itinerary_id}/segmentsCreates a new segment within the itinerary, at the end of its chain or anywhere before it, and renumbers the chain.
Webhook events itinerary.segment.created, itinerary.segment.updated, itinerary.segment_group.deleted, recorded by the tasks itinerary.segment.create, itinerary.segment.insert.
Path parameters
itinerary_idstring (uuid)
in path
Identifier of the itinerary the operation acts on. An itinerary this credential does not reach is a 404 rather than a 403, and so is one that does not exist, so the parameter cannot be used to learn which itinerary ids exist.
Headers
Idempotency-Keystring
in header
A value the caller chooses once per logical write and sends again, unchanged, on every retry of it, so a write whose answer was lost runs at most once. A UUID is the usual choice; any 1 to 255 printable ASCII characters without a space are accepted. The key is held for 12 hours, for the credential that sent it (the publishable key and the user its session token names) and for this operation.
If-Matchstring
in header
Makes the write conditional on the resource still being the version the caller read: the ETag an earlier answer carried, which is also that resource's etag field, or * for any version. When the resource has changed since, the write is refused with 412 PRECONDITION_FAILED, nothing is changed, and the answer carries the current ETag, so the caller reads the resource again and decides. Omitted, the write is unconditional and the last write wins.
Body
The new segment: its mode, its color, and either the positions to route between or the geometry to draw freehand, and, to place it anywhere but the end of the chain, before_segment_id, the segment it goes ahead of. The server assigns the position; a field the body does not declare, such as position, is a 400 naming it.
before_segment_idstring (uuid)
in body
Identifier of the segment the new one is inserted BEFORE, so the first segment's identifier inserts at the head of the chain. Optional and not nullable: omit it to append the new segment to the end of the chain.
colorstring
in body
Hex color code for rendering this segment on the map. Both the three-digit and the six-digit forms are accepted, in either case, and either is stored as six lowercase digits (#F60 and #FF6600 both as #ff6600), which is the form every read returns.
descriptionstring
in body
Free-text description of the segment, at most 100 characters as sent, leading and trailing whitespace included; that whitespace is then trimmed. Omit it, or send one that trims to nothing, to create the segment without one.
geojsonGeoJSONPoint | GeoJSONMultiPoint | GeoJSONLineString | GeoJSONMultiLineString | GeoJSONPolygon | GeoJSONMultiPolygon | GeoJSONGeometryCollection
in body
The segment's path, as mode reads it. In directions mode it is a MultiPoint of 2 to 45 waypoints the route passes through in order, and the straight line through them must not exceed 100 km; what is stored is the route computed between them. The MultiPoint is sent bare or inside a GeometryCollection, the shape a directions segment is read in, and only the collection's MultiPoint is read: a LineString beside it is ignored.
modestring
in body
One of: directions, linestring
How the segment's path is defined, which decides what geojson must carry: directions routes between the waypoints of a MultiPoint, linestring keeps the drawn line rather than routing it.
namestring
in body
Display name of the segment, 2 to 30 characters as sent. Leading and trailing whitespace is then trimmed, and what remains must still be at least 2 characters. A name is one line: a tab, a line break or a line separator between two of its characters is a 400, and one at either end is trimmed with the whitespace there.
speednumber (double)
in body
Travel speed in km/h used to compute the segment duration. At least 0.01 and at most 999.99, and stored rounded to two decimal places.
start_atstring (date-time)
in body
Planned start date and time for this segment.
Response 201
The whole itinerary after the create, with the new segment in its place and the chain renumbered around it. Location names the new segment, /v1/itineraries/{itinerary_id}/segments/{segment_id}, and extensions.metadata.created.id is its identifier. ETag carries the itinerary's new version.
extensionsobject
The envelope's second half, everything the answer carries that is not the answer itself. Here that is metadata.created, the segment this request created.
dataItineraryWithDetails
An itinerary with its full list of segments, waypoints, and segment groups included, plus its derived publication state.
Errors 400, 401, 402, 403, 404, 409, 412, 413, 429, 500, 504. See Errors.
/v1/itineraries/{itinerary_id}/segments/{segment_id}Updates an existing segment within the itinerary. Every field is optional: an omitted field keeps its current value, and null clears a nullable one. A new geojson re-derives the segment's geometry and totals, and the shared points of the neighbouring segments follow it. The segment's mode is changed by its own operation, postItinerarySegmentConvert.
Webhook events itinerary.segment.updated, itinerary.segment_group.deleted, recorded by the task itinerary.segment.update.
Path parameters
itinerary_idstring (uuid)
in path
Identifier of the itinerary the operation acts on. An itinerary this credential does not reach is a 404 rather than a 403, and so is one that does not exist, so the parameter cannot be used to learn which itinerary ids exist.
segment_idstring (uuid)
in path
Identifier of the segment within the itinerary named by itinerary_id. A segment belonging to another itinerary is a 404, not a 403.
Headers
Idempotency-Keystring
in header
A value the caller chooses once per logical write and sends again, unchanged, on every retry of it, so a write whose answer was lost runs at most once. A UUID is the usual choice; any 1 to 255 printable ASCII characters without a space are accepted. The key is held for 12 hours, for the credential that sent it (the publishable key and the user its session token names) and for this operation.
If-Matchstring
in header
Makes the write conditional on the resource still being the version the caller read: the ETag an earlier answer carried, which is also that resource's etag field, or * for any version. When the resource has changed since, the write is refused with 412 PRECONDITION_FAILED, nothing is changed, and the answer carries the current ETag, so the caller reads the resource again and decides. Omitted, the write is unconditional and the last write wins.
Body
The fields to change. A field you omit keeps its stored value, and a nullable field sent as null is cleared. A field the body does not declare, such as mode or position, is a 400 naming it: the mode has its own operation, and the position is the chain's to assign.
colorstring | null
in body
Hex color code for rendering this segment on the map. Both the three-digit and the six-digit forms are accepted, in either case, and either is stored as six lowercase digits (#F60 and #FF6600 both as #ff6600), which is the form every read returns. Omit to keep the current value; null returns the segment to the default activity color.
descriptionstring | null
in body
Free-text description of the segment, at most 100 characters as sent, leading and trailing whitespace included; that whitespace is then trimmed. Omit to keep the current value; null, or a value that trims to nothing, clears it.
geojsonGeoJSONPoint | GeoJSONMultiPoint | GeoJSONLineString | GeoJSONMultiLineString | GeoJSONPolygon | GeoJSONMultiPolygon | GeoJSONGeometryCollection
in body
GeoJSON Geometry representing the segment path, read as the segment's mode reads it on creation. In directions mode it is a MultiPoint of 2 to 45 waypoints (inclusive), sent bare or inside a GeometryCollection whose MultiPoint alone is read, and the straight line through them must not exceed 100 km. In linestring mode it is a LineString, sent bare or inside a GeometryCollection, kept as drawn rather than routed and simplified and resampled as it is on creation. When that collection also holds a MultiPoint, the MultiPoint is read as the vertices drawn and the LineString only has to hold two positions, so a segment read with its drawn vertices changes path through its MultiPoint, or through a bare LineString sent in its place. Either way the segment's geojson as read is accepted back unchanged.
namestring
in body
Display name of the segment. Omit to keep the current value. 2 to 30 characters as sent; leading and trailing whitespace is then trimmed, and what remains must still be at least 2 characters. A name is one line: a tab, a line break or a line separator between two of its characters is a 400, and one at either end is trimmed with the whitespace there.
speednumber (double) | null
in body
Travel speed in km/h used to compute the segment duration. Omit to keep the current value; null returns the segment to the default activity speed. At least 0.01 and at most 999.99, and stored rounded to two decimal places.
start_atstring (date-time) | null
in body
Planned start date and time for this segment. Omit to keep the current value; null clears it.
Response 200
The whole itinerary after the update, with the segment's geometry and totals recomputed, and its new ETag.
extensionsobject
Top-level extensions map for 2xx responses. Mirrors the GraphQL-spec response extensions: a free-form map for response-scoped metadata.
dataItineraryWithDetails
An itinerary with its full list of segments, waypoints, and segment groups included, plus its derived publication state.
Errors 400, 401, 402, 403, 404, 409, 412, 413, 429, 500, 504. See Errors.
/v1/itineraries/{itinerary_id}/segments/{segment_id}Permanently deletes the segment. This action cannot be undone.
Webhook events itinerary.segment.deleted, itinerary.segment_group.deleted, recorded by the task itinerary.segment.delete.
Path parameters
itinerary_idstring (uuid)
in path
Identifier of the itinerary the operation acts on. An itinerary this credential does not reach is a 404 rather than a 403, and so is one that does not exist, so the parameter cannot be used to learn which itinerary ids exist.
segment_idstring (uuid)
in path
Identifier of the segment within the itinerary named by itinerary_id. A segment belonging to another itinerary is a 404, not a 403.
Headers
Idempotency-Keystring
in header
A value the caller chooses once per logical write and sends again, unchanged, on every retry of it, so a write whose answer was lost runs at most once. A UUID is the usual choice; any 1 to 255 printable ASCII characters without a space are accepted. The key is held for 12 hours, for the credential that sent it (the publishable key and the user its session token names) and for this operation.
If-Matchstring
in header
Makes the write conditional on the resource still being the version the caller read: the ETag an earlier answer carried, which is also that resource's etag field, or * for any version. When the resource has changed since, the write is refused with 412 PRECONDITION_FAILED, nothing is changed, and the answer carries the current ETag, so the caller reads the resource again and decides. Omitted, the write is unconditional and the last write wins.
Response 200
The whole itinerary after the delete, the remaining segments renumbered, and its new ETag.
extensionsobject
Top-level extensions map for 2xx responses. Mirrors the GraphQL-spec response extensions: a free-form map for response-scoped metadata.
dataItineraryWithDetails
An itinerary with its full list of segments, waypoints, and segment groups included, plus its derived publication state.
Errors 400, 401, 402, 403, 404, 409, 412, 429, 500, 504. See Errors.
/v1/itineraries/{itinerary_id}/segments/{segment_id}/mergeFuses the segment into a single segment together with the next one in the chain, and renumbers the chain. The direction is fixed and takes no parameter: on an ordered chain, merging segment i with i-1 is the same operation as merging i-1 with its next, so a direction field would only add a redundant way to express the same request. The merged result keeps the identifier of the lower-positioned of the two.
Webhook events itinerary.segment.merged, itinerary.segment.deleted, itinerary.segment_group.deleted, recorded by the task itinerary.segment.merge.
Path parameters
itinerary_idstring (uuid)
in path
Identifier of the itinerary the operation acts on. An itinerary this credential does not reach is a 404 rather than a 403, and so is one that does not exist, so the parameter cannot be used to learn which itinerary ids exist.
segment_idstring (uuid)
in path
Identifier of the segment within the itinerary named by itinerary_id. A segment belonging to another itinerary is a 404, not a 403.
Headers
Idempotency-Keystring
in header
A value the caller chooses once per logical write and sends again, unchanged, on every retry of it, so a write whose answer was lost runs at most once. A UUID is the usual choice; any 1 to 255 printable ASCII characters without a space are accepted. The key is held for 12 hours, for the credential that sent it (the publishable key and the user its session token names) and for this operation.
If-Matchstring
in header
Makes the write conditional on the resource still being the version the caller read: the ETag an earlier answer carried, which is also that resource's etag field, or * for any version. When the resource has changed since, the write is refused with 412 PRECONDITION_FAILED, nothing is changed, and the answer carries the current ETag, so the caller reads the resource again and decides. Omitted, the write is unconditional and the last write wins.
Response 200
The whole itinerary after the merge: the two segments are one, carrying the lower-positioned segment's identifier, and the ordering after them has closed up. ETag carries the itinerary's new version.
extensionsobject
Top-level extensions map for 2xx responses. Mirrors the GraphQL-spec response extensions: a free-form map for response-scoped metadata.
dataItineraryWithDetails
An itinerary with its full list of segments, waypoints, and segment groups included, plus its derived publication state.
Errors 400, 401, 402, 403, 404, 409, 412, 429, 500, 504. See Errors.
/v1/itineraries/{itinerary_id}/segments/{segment_id}/convertConverts the segment to the mode the body names, routed (directions) or freehand (linestring), and re-derives its geometry accordingly. This is its own operation rather than a field on patchItinerarySegment because it can fail routing where a metadata update cannot, and giving it a dedicated operation leaves exactly one way to change a segment's engine.
Webhook events itinerary.segment.converted, itinerary.segment_group.deleted, recorded by the task itinerary.segment.convert.
Path parameters
itinerary_idstring (uuid)
in path
Identifier of the itinerary the operation acts on. An itinerary this credential does not reach is a 404 rather than a 403, and so is one that does not exist, so the parameter cannot be used to learn which itinerary ids exist.
segment_idstring (uuid)
in path
Identifier of the segment within the itinerary named by itinerary_id. A segment belonging to another itinerary is a 404, not a 403.
Headers
Idempotency-Keystring
in header
A value the caller chooses once per logical write and sends again, unchanged, on every retry of it, so a write whose answer was lost runs at most once. A UUID is the usual choice; any 1 to 255 printable ASCII characters without a space are accepted. The key is held for 12 hours, for the credential that sent it (the publishable key and the user its session token names) and for this operation.
If-Matchstring
in header
Makes the write conditional on the resource still being the version the caller read: the ETag an earlier answer carried, which is also that resource's etag field, or * for any version. When the resource has changed since, the write is refused with 412 PRECONDITION_FAILED, nothing is changed, and the answer carries the current ETag, so the caller reads the resource again and decides. Omitted, the write is unconditional and the last write wins.
Body
The mode to convert the segment to. Converting between routed and freehand recomputes or discards the routed geometry accordingly.
modestring
in body
One of: directions, linestring
How the segment's path is defined, which decides what geojson must carry: directions routes between the waypoints of a MultiPoint, linestring keeps the drawn line rather than routing it.
Response 200
The whole itinerary after the conversion, because converting between routed and freehand recomputes the segment's geometry and the totals that depend on it. ETag carries the itinerary's new version.
extensionsobject
Top-level extensions map for 2xx responses. Mirrors the GraphQL-spec response extensions: a free-form map for response-scoped metadata.
dataItineraryWithDetails
An itinerary with its full list of segments, waypoints, and segment groups included, plus its derived publication state.
Errors 400, 401, 402, 403, 404, 409, 412, 413, 429, 500, 504. See Errors.
/v1/itineraries/{itinerary_id}/segments/{segment_id}/splitCuts the segment into two consecutive segments at the given fraction of its length, and renumbers the chain. The first half keeps the original identifier; the second is created after it. Both halves inherit the original segment's group, so a split never breaks a group's contiguity.
Webhook events itinerary.segment.split, itinerary.segment.created, itinerary.segment_group.deleted, recorded by the task itinerary.segment.split.
Path parameters
itinerary_idstring (uuid)
in path
Identifier of the itinerary the operation acts on. An itinerary this credential does not reach is a 404 rather than a 403, and so is one that does not exist, so the parameter cannot be used to learn which itinerary ids exist.
segment_idstring (uuid)
in path
Identifier of the segment within the itinerary named by itinerary_id. A segment belonging to another itinerary is a 404, not a 403.
Headers
Idempotency-Keystring
in header
A value the caller chooses once per logical write and sends again, unchanged, on every retry of it, so a write whose answer was lost runs at most once. A UUID is the usual choice; any 1 to 255 printable ASCII characters without a space are accepted. The key is held for 12 hours, for the credential that sent it (the publishable key and the user its session token names) and for this operation.
If-Matchstring
in header
Makes the write conditional on the resource still being the version the caller read: the ETag an earlier answer carried, which is also that resource's etag field, or * for any version. When the resource has changed since, the write is refused with 412 PRECONDITION_FAILED, nothing is changed, and the answer carries the current ETag, so the caller reads the resource again and decides. Omitted, the write is unconditional and the last write wins.
Body
Where to split the segment, as a fraction of its length between 0 and 1. The one segment becomes two, and the ordering after it shifts.
first_namestring
in body
Display name for the first half, the one that keeps the original segment's identifier. Omit to leave the original's name unchanged. 2 to 30 characters as sent; leading and trailing whitespace is then trimmed, and what remains must still be at least 2 characters. A name is one line: a tab, a line break or a line separator between two of its characters is a 400, and one at either end is trimmed with the whitespace there.
fractionnumber (double)
in body
Position of the split along the segment, as a fraction of its length in the open interval (0, 1). 0.5 splits it in half.
second_namestring
in body
Display name for the second half, the segment created after the first. Omit to inherit the original's name. 2 to 30 characters as sent; leading and trailing whitespace is then trimmed, and what remains must still be at least 2 characters. A name is one line: a tab, a line break or a line separator between two of its characters is a 400, and one at either end is trimmed with the whitespace there.
Response 201
The whole itinerary after the split: one segment has become two, and the ordering after them has shifted. Location names the second half, the segment the split created, /v1/itineraries/{itinerary_id}/segments/{segment_id}, and extensions.metadata.created.id is its identifier. ETag carries the itinerary's new version.
extensionsobject
The envelope's second half, everything the answer carries that is not the answer itself. Here that is metadata.created, the second half, the segment this split created.
dataItineraryWithDetails
An itinerary with its full list of segments, waypoints, and segment groups included, plus its derived publication state.
Errors 400, 401, 402, 403, 404, 409, 412, 413, 429, 500, 504. See Errors.
/v1/itineraries/{itinerary_id}/segment-groupsCreates a segment group over the given segments. The segments themselves are unchanged: grouping only overrides the name, color, and speed shown for that run on the elevation profile and in the segment chooser, and every member stays individually selectable and editable.
Webhook events itinerary.segment_group.created, itinerary.segment_group.deleted, recorded by the task itinerary.segment_group.create.
Path parameters
itinerary_idstring (uuid)
in path
Identifier of the itinerary the operation acts on. An itinerary this credential does not reach is a 404 rather than a 403, and so is one that does not exist, so the parameter cannot be used to learn which itinerary ids exist.
Headers
Idempotency-Keystring
in header
A value the caller chooses once per logical write and sends again, unchanged, on every retry of it, so a write whose answer was lost runs at most once. A UUID is the usual choice; any 1 to 255 printable ASCII characters without a space are accepted. The key is held for 12 hours, for the credential that sent it (the publishable key and the user its session token names) and for this operation.
If-Matchstring
in header
Makes the write conditional on the resource still being the version the caller read: the ETag an earlier answer carried, which is also that resource's etag field, or * for any version. When the resource has changed since, the write is refused with 412 PRECONDITION_FAILED, nothing is changed, and the answer carries the current ETag, so the caller reads the resource again and decides. Omitted, the write is unconditional and the last write wins.
Body
The new group's name and color, and the segments it gathers.
colorstring
in body
Hex color code used to paint the whole run as one band. Required, because a group with no color is indistinguishable from no group at all. Both the three-digit and the six-digit forms are accepted, in either case, and either is stored as six lowercase digits (#F60 and #FF6600 both as #ff6600), which is the form every read returns.
namestring
in body
Display name of the segment group, 2 to 30 characters as sent. Leading and trailing whitespace is then trimmed, and what remains must still be at least 2 characters. A name is one line: a tab, a line break or a line separator between two of its characters is a 400, and one at either end is trimmed with the whitespace there.
segment_idsarray of string (uuid)
in body
Identifiers of the segments to group. They must form a contiguous run of the itinerary's chain (their positions must be consecutive, in any order within the array) and none may already belong to another group.
speednumber (double)
in body
Travel speed in km/h applied to the whole run when computing the displayed duration. At least 0.01 and at most 999.99, and stored rounded to two decimal places.
Response 201
The whole itinerary, with the new group and the segments gathered into it. Location names the group, /v1/itineraries/{itinerary_id}/segment-groups/{group_id}, and extensions.metadata.created.id is its identifier. ETag carries the itinerary's new version.
extensionsobject
The envelope's second half, everything the answer carries that is not the answer itself. Here that is metadata.created, the segment group this request created.
dataItineraryWithDetails
An itinerary with its full list of segments, waypoints, and segment groups included, plus its derived publication state.
Errors 400, 401, 402, 403, 404, 409, 412, 413, 429, 500, 504. See Errors.
/v1/itineraries/{itinerary_id}/segment-groups/{group_id}Updates the group's name, color, speed, or membership. Membership changes obey the same rules as creation: the segments must form a contiguous run of the chain and at least two are required, each a 400 otherwise, and none may already belong to another group, a 409 naming each such segment's position in segment_ids. Segments dropped from the run are un-grouped.
Webhook events itinerary.segment_group.updated, itinerary.segment_group.deleted, recorded by the task itinerary.segment_group.update.
Path parameters
itinerary_idstring (uuid)
in path
Identifier of the itinerary the operation acts on. An itinerary this credential does not reach is a 404 rather than a 403, and so is one that does not exist, so the parameter cannot be used to learn which itinerary ids exist.
group_idstring (uuid)
in path
Identifier of the segment group within the itinerary named by itinerary_id.
Headers
Idempotency-Keystring
in header
A value the caller chooses once per logical write and sends again, unchanged, on every retry of it, so a write whose answer was lost runs at most once. A UUID is the usual choice; any 1 to 255 printable ASCII characters without a space are accepted. The key is held for 12 hours, for the credential that sent it (the publishable key and the user its session token names) and for this operation.
If-Matchstring
in header
Makes the write conditional on the resource still being the version the caller read: the ETag an earlier answer carried, which is also that resource's etag field, or * for any version. When the resource has changed since, the write is refused with 412 PRECONDITION_FAILED, nothing is changed, and the answer carries the current ETag, so the caller reads the resource again and decides. Omitted, the write is unconditional and the last write wins.
Body
The fields to change. A field you omit keeps its stored value, and a nullable field sent as null is cleared. A field the body does not declare, such as revision, is a 400 naming it: no request takes a revision.
colorstring
in body
Hex color code used to paint the whole run as one band. Both the three-digit and the six-digit forms are accepted, in either case, and either is stored as six lowercase digits (#F60 and #FF6600 both as #ff6600), which is the form every read returns. Optional and not nullable: omit it to keep the current color. A group always has one, so there is nothing for null to clear.
namestring
in body
Display name of the segment group, 2 to 30 characters as sent. Leading and trailing whitespace is then trimmed, and what remains must still be at least 2 characters. Optional and not nullable: omit it to keep the current name. A name is one line: a tab, a line break or a line separator between two of its characters is a 400, and one at either end is trimmed with the whitespace there.
segment_idsarray of string (uuid)
in body
The group's new membership, replacing the current one. Optional and not nullable: omit it to leave the membership untouched. Same rules as on creation: the segments must form a contiguous run of the itinerary's chain, none may already belong to another group, and at least two are required. Segments dropped from the array are un-grouped; to dissolve the group entirely, delete it instead. The upper bound is the one every identifier array on this surface carries, and a repeated identifier is refused rather than collapsed, for the reason creation gives.
speednumber (double) | null
in body
Travel speed in km/h applied to the whole run when computing the displayed duration. At least 0.01 and at most 999.99, and stored rounded to two decimal places. Omit it to keep the current override; null removes it, and each member segment falls back to its own speed.
Response 200
The whole itinerary after the update, and its new ETag.
extensionsobject
Top-level extensions map for 2xx responses. Mirrors the GraphQL-spec response extensions: a free-form map for response-scoped metadata.
dataItineraryWithDetails
An itinerary with its full list of segments, waypoints, and segment groups included, plus its derived publication state.
Errors 400, 401, 402, 403, 404, 409, 412, 413, 429, 500, 504. See Errors.
/v1/itineraries/{itinerary_id}/segment-groups/{group_id}Dissolves the group. Its members are un-grouped and are otherwise untouched: each keeps its own name, color, speed, geometry, metrics, and position, and the elevation profile goes back to showing them as separate bands. No segment is ever deleted by this operation. Clearing a member's group_id writes no new revision of it, so its revision does not move.
Webhook events itinerary.segment_group.deleted, recorded by the task itinerary.segment_group.delete.
Path parameters
itinerary_idstring (uuid)
in path
Identifier of the itinerary the operation acts on. An itinerary this credential does not reach is a 404 rather than a 403, and so is one that does not exist, so the parameter cannot be used to learn which itinerary ids exist.
group_idstring (uuid)
in path
Identifier of the segment group within the itinerary named by itinerary_id.
Headers
Idempotency-Keystring
in header
A value the caller chooses once per logical write and sends again, unchanged, on every retry of it, so a write whose answer was lost runs at most once. A UUID is the usual choice; any 1 to 255 printable ASCII characters without a space are accepted. The key is held for 12 hours, for the credential that sent it (the publishable key and the user its session token names) and for this operation.
If-Matchstring
in header
Makes the write conditional on the resource still being the version the caller read: the ETag an earlier answer carried, which is also that resource's etag field, or * for any version. When the resource has changed since, the write is refused with 412 PRECONDITION_FAILED, nothing is changed, and the answer carries the current ETag, so the caller reads the resource again and decides. Omitted, the write is unconditional and the last write wins.
Response 200
The whole itinerary after the group is removed. The segments it gathered survive, ungrouped.
extensionsobject
Top-level extensions map for 2xx responses. Mirrors the GraphQL-spec response extensions: a free-form map for response-scoped metadata.
dataItineraryWithDetails
An itinerary with its full list of segments, waypoints, and segment groups included, plus its derived publication state.
Errors 400, 401, 402, 403, 404, 409, 412, 429, 500, 504. See Errors.