Collections

Cancel a collection

Stop a collection you no longer want. One that has not started yet stops at once and costs nothing. One already running keeps the places that have arrived and the credits they cost; the search in flight finishes, and nothing new starts. A collection that has already ended cannot be cancelled. Needs an API key. Costs no credits.

delete/collections/{id}

Request

  • Base URL: https://api.gmaps.dev/v1
  • URL: https://api.gmaps.dev/v1/collections/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The collection's id, as create_collection returned it.

Response

Cancel a collection

Changes

No recorded changes to this operation across all 1 revision of this API.