Skip to main content
POST
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

Body

application/json

The request body used to create a new shuttle subject mapping.

job_id
string
required

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

Example:

"6a3ba68e810d9156194530a1"

discovered_subject_id
string
required

The unique identifier of the discovered subject to map.

Example:

"6a3ba7c02ea17bc9461eeacf"

revision
integer<int32>

The discovery-requirements revision to resolve against. Omit to use the latest revision.

Example:

3

is_subject_skipped
boolean
default:false

Whether this subject should be skipped during the migration. Defaults to false.

Example:

false

target
Shuttle target subject input · object

The Box target to map to. Omit or set to null when the subject is skipped.

Example:

Response

Returns the newly created 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