curl -X DELETE 'https://api.cyclemate.club/custom-routes/78360cf7-0f4a-48f1-91ca-25e83db44aff/images/3f8e3b35-25c5-48bb-a5ab-486ad4c6a5a1/' \
-H 'Authorization: Bearer ACCESS_TOKEN'
204 No Content
Custom routes
Delete an image
Remove a photo from a route you host
curl -X DELETE 'https://api.cyclemate.club/custom-routes/78360cf7-0f4a-48f1-91ca-25e83db44aff/images/3f8e3b35-25c5-48bb-a5ab-486ad4c6a5a1/' \
-H 'Authorization: Bearer ACCESS_TOKEN'
204 No Content
Overview
Removes the image and its file and answers204 with no body. Hosts only.
Authentication
A Login with Cyclemate access token, or a signed-in rider’s session token. Every route belongs to a rider: your app acts for the rider who connected it, and the route is theirs. Your app reaches only the routes it created: a route the rider made in our apps, or through another app, answers404.
Authorization: Bearer ACCESS_TOKEN
Rate limits
Riders and apps acting for them may make 60 requests a minute; a request that routes betweenstops counts once per hop. Every rider may create 10 routes in any 24 hours, counted across our apps and every connected app: the eleventh answers 429 with code: "daily_limit" and the seconds until a slot frees.
Path parameters
string
required
The route’s id.
string
required
The image’s id, as returned when it was uploaded or in the route’s
images.Response body
No body. The status is204.
curl -X DELETE 'https://api.cyclemate.club/custom-routes/78360cf7-0f4a-48f1-91ca-25e83db44aff/images/3f8e3b35-25c5-48bb-a5ab-486ad4c6a5a1/' \
-H 'Authorization: Bearer ACCESS_TOKEN'
204 No Content
Variants
The cover
Deleting the cover makes the next image the cover.Error responses
Every error body is{ "error", "code" }; error is a sentence, code is stable.
400 Bad request
Invalid body or query: the message names the field.code is invalid_body, or for a route input outside_coverage (the route starts outside the cities we cover), cross_city (its stops span two cities) or no_route (no cycling route exists between two stops).
{ "error": "unknown field: colour", "code": "invalid_body" }
401 Unauthorized
Missing or invalid credentials, or an anonymous caller.{ "error": "Missing user credentials" }
404 Not found
No route with that id that you may see. A private route you do not host, a route you may read but not edit, and a route your app did not create all answer404, never 403.
{ "error": "Custom route not found", "code": "not_found" }
405 Method not allowed
{ "error": "Method not allowed", "code": "method_not_allowed" }
429 Too many requests
The burst limit, with aRetry-After header; or the daily creation cap, which adds code: "daily_limit".
{ "error": "Daily limit of 10 custom routes reached", "code": "daily_limit", "retry_after_seconds": 3600 }
500 Internal server error
{ "error": "Internal server error", "code": "internal_error" }