Skip to main content
PUT
Learn more about Box SDK versioning strategy.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

box-version
enum<string>
required

Version header.

Available options:
2026.0

Path Parameters

shuttle_subject_mapping_id
string
required

The unique identifier for the shuttle subject mapping.

Body

application/json

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.

is_subject_skipped
boolean

Whether this subject should be skipped during the migration.

Example:

true

target
Shuttle target subject input · object

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.

Example:

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.

id
string
required

The unique identifier for the shuttle subject mapping.

Example:

"6a3ba7b12ea17bc9461eeace"

type
enum<string>
required

The value will always be shuttle_subject_mapping.

Available options:
shuttle_subject_mapping
Example:

"shuttle_subject_mapping"

job_id
string
required

The unique identifier of the shuttle job this mapping belongs to.

Example:

"6a3ba68e810d9156194530a1"

is_subject_skipped
boolean
required

Whether this subject is skipped during the migration.

Example:

false

source
Shuttle subject · object
required

The source subject being mapped.

discovered_subject_id
string | null

The unique identifier of the discovered subject this mapping applies to. null for legacy mappings created before this field was tracked.

Example:

"6a3ba7c02ea17bc9461eeacf"

revision
integer<int32> | null

The discovery-requirements revision this mapping was resolved against. null for legacy mappings.

Example:

3

target
Shuttle target subject · object

The Box target subject. null when the subject is skipped or not yet assigned.

Example:
Last modified on October 26, 2026