Donate using PayPal

CycleStreets API (v2)

  • Details for:
  • API overview
  • Obtain API key
  • Usage policy
  • Uptime policy

Batch routes matrix - delete job

This API call enables a job definition to be deleted.

When you have planned a job and retrieved its data, you are expected to delete it using this API call. Any jobs left on the system three months after creation are subject to deletion without notice.


Example which deletes a job.

	[id] => 69158
	[username] => myusername
	[password] => mypassword


    "id": 69158,
    "status": "deleted"

Request parameters - required

id int
Batch job ID, as returned from batchroutes.createjob.
username string
Your CycleStreets account username. In due course this will be replaced with an OAuth token.
password string
Your CycleStreets account password.

Request parameters - optional



JSON response as above.

Error response

JSON object containing an error key and a text string.

Example error (text string will vary):

    "error": "The job you requested to delete is either non-existent or is owned by another user."

We welcome your feedback, especially to report bugs or give us route feedback.

My comments relate to: *

Your comments: *
URL of page: *
How did you find out about CycleStreets?:
Your name:
Our ref: Please leave blank - anti-spam measure

* Items marked with an asterisk [*] are required fields and must be fully completed.