Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mapping.travel/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to manually trigger an export of the results from a completed mapping job. Exports are generated asynchronously. When the export is ready, you receive an exportFileId that you can use to download the file. If the job has no results or cannot be found, the response indicates failure without returning an HTTP error status.
Exports may also be triggered automatically depending on your organization’s export configuration. Use this endpoint when you need to re-export results on demand or generate an export outside the automatic schedule.

Request

POST https://api.mapping.travel/api/v1/mapping/{mappingJobId}/export
mappingJobId
string
required
UUID of the mapping job to export results for.
This endpoint takes no request body.

Response

This endpoint always returns HTTP 200 OK. Check the success field to determine whether the export was actually triggered.
success
boolean
required
true if the export was triggered successfully. false if the job was not found, had no results, or the export failed for another reason.
exportFileId
string
UUID of the generated export file. Present only when success is true. Use this ID to download the export file.
message
string
required
Human-readable description of the outcome. Provides detail when success is false.

Error responses

StatusReason
401 UnauthorizedMissing or invalid Authorization header.
404 Not FoundNo mapping job with the given ID exists for your organization.
A 200 OK response does not guarantee the export succeeded. Always check success: true in the response body before using the exportFileId. If success is false, the message field explains why.

Example

curl --request POST \
  --url https://api.mapping.travel/api/v1/mapping/f7e6d5c4-b3a2-1098-fedc-ba9876543210/export \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "exportFileId": "e1f2a3b4-c5d6-7890-abcd-ef0987654321",
  "message": "Export triggered successfully"
}