Delete Trip API

Explore how to delete a trip with our Trip API

Delete Trip

DELETE https://api.roam.ai/v2/trips/:id

You can delete the trip via this API. Deleting a trip does not affect any users who have already completed the trip; however the user can't start a previously created trip if it is deleted.

Path Parameters

Name	Type	Description
id*	String	Exports the trip summary with the given ID.

Headers

Name	Type	Description
Authorization*	String	Bearer <API-KEY>

200: OK Trip deleted

{
    "message": "trip_deleted",
    "description": "The trip data is deleted for given id.",
    "code": 200,
    "trip": {
        "id": "61dec6e206f8a019b2402c0b",
        "is_deleted": true
    }
}

404: Not Found Object not found

{
  "code" : 404,
  "message" : "object_not_found",
  "description": "The requested object does not exist or already deleted.",
  "errors" : [ ]
}

Example

cURL

curl --location --request DELETE 'https://api.roam.ai/v2/trips/620f4fb7d79b3200007cd92c' \
--header 'Authorization: Bearer dfbbf5d5XXXXcb1166147b87c0544'