Create shuttle path mapping import
Accepts a spreadsheet of path mappings, already stored in Box, and replaces the job’s path mappings. A file that is not a mapping workbook, or that exceeds the size or row limits (10 MiB Box download limit; 100,000 mapping rows), returns 400 synchronously and leaves the job unchanged. An accepted import always replaces every path mapping on the job. When all rows are valid the workbook is deployed in full. When any row is invalid the job ends with no path mappings and mapping_state becomes paths_import_rejected until the next import or the next manual path-mapping change. Row problems are listed by GET /shuttle_mapping_errors?job_id=… with category path_import, messages of the form Row N: …, at most 500 entries plus one overflow entry. Validation and deployment are asynchronous after acceptance. Poll GET /shuttle_jobs/{shuttle_job_id} while mapping_state is importing_paths. Only one import may be in flight per job.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Version header.
2026.0 Body
The request body used to import a shuttle job's path mappings from a spreadsheet already stored in Box.
The unique identifier of the shuttle job whose path mappings are replaced.
"6a3ba68e810d9156194530a1"
The unique identifier of the Box file holding the mapping workbook. The file is read as the calling user, so it must live somewhere that user can download from.
"12345678901"
Response
The import was accepted. Validation and deployment continue asynchronously. Poll GET /shuttle_jobs/{shuttle_job_id} until mapping_state is no longer importing_paths. A rejected import ends with mapping_state paths_import_rejected and an empty path-mapping list; a successful import moves on to a later mapping-preparation state such as paths_ready or ready.