Update shuttle subject mapping
Updates the mutable properties of an existing shuttle subject mapping identified by its ID. Only the fields supplied in the request body are changed.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Version header.
2026.0 Path Parameters
The unique identifier for the shuttle subject mapping.
Body
The request body used to update an existing shuttle subject mapping. Only the fields supplied in the request body are changed. job_id, id, type, source, discovered_subject_id, and revision are immutable.
Whether this subject should be skipped during the migration.
true
The Box target to map to. Set to null only for a skipped subject. Setting it to null while the mapping is active fails validation. Updating is_subject_skipped alone preserves the existing target.
- Shuttle target subject input
- OpenAPI 3.0 null schema type
Response
Returns the updated shuttle subject mapping.
A standard representation of a shuttle subject mapping. A subject mapping connects a discovered source subject to a Box user or group, or marks the subject as skipped.
The unique identifier for the shuttle subject mapping.
"6a3ba7b12ea17bc9461eeace"
The value will always be shuttle_subject_mapping.
shuttle_subject_mapping "shuttle_subject_mapping"
The unique identifier of the shuttle job this mapping belongs to.
"6a3ba68e810d9156194530a1"
Whether this subject is skipped during the migration.
false
The source subject being mapped.
The unique identifier of the discovered subject this mapping applies to. null for legacy mappings created before this field was tracked.
"6a3ba7c02ea17bc9461eeacf"
The discovery-requirements revision this mapping was resolved against. null for legacy mappings.
3
The Box target subject. null when the subject is skipped or not yet assigned.
- Shuttle target subject
- OpenAPI 3.0 null schema type
