Skip to main content
POST
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.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.

Path Parameters

upload_session_id
string
required

The ID of the upload session.

Body

application/json

Request body for planning an upload session. This allows checking which parts already exist on the server before uploading.

parts
Upload part plan · object[]
required

The list of parts to check for existence.

Minimum array length: 1
Example:

Response

Returns information about which parts already exist (hits) and which parts need to be uploaded (misses).

Response from planning an upload session. Contains information about which parts already exist (hits) and which need to be uploaded (misses).

upload_session_id
string
required

The unique identifier for this upload session.

Example:

"F971964745A5CD0C001BBE4E58196BFD"

hits
Upload part plan hit · object[]
required

Parts that already exist on the server and do not need to be uploaded again.

Example:
misses
Upload part plan · object[]
required

Parts that do not exist on the server and need to be uploaded.

Example:
Last modified on September 4, 2026