sharepoint Code Check-In Required Error

How to Fix SharePoint Error Check-In Required Error

Diagnostic Procedures

  • 1 Understand the Root Causes of Check-In Required Errors
  • 2 Step 1: Check In Files via SharePoint Web Browser
  • 3 Step 2: Complete Mandatory Metadata Columns
  • 4 Step 3: Modify Library Checkout Settings (Administrators)
  • 5 Step 4: Reset the OneDrive Sync Client

How to Fix SharePoint Error Check-In Required Error

Encountering a Check-In Required Error in SharePoint occurs when a document library is configured to require files to be checked out before they can be edited. This setting blocks other team members from viewing your edits, stops automated workflows, and causes the OneDrive/SharePoint sync client to halt uploads.

This guide explains how to check files back in, resolve metadata blocks, and reset the sync client to clear the error.


Understand the Root Causes of Check-In Required Errors

The check-in required error is typically caused by:

  1. Mandatory Checkout Setting: The SharePoint library has “Require documents to be checked out before they can be edited” set to Yes.
  2. Missing Required Metadata: The library has columns (like choice, date, or text fields) marked as “Required”. When a file is uploaded without these values, SharePoint automatically checks it out and hides it from other users.
  3. Ghosted Local Files: The file was modified locally, but the sync client failed to complete the upload handshake, leaving it locked in a checked-out state on the server.

Resolving SharePoint Check-In Required Errors

Follow these steps to check in your files and restore synchronization:

Step 1: Check In Files via SharePoint Web Browser

If a file is locked or checked out, you must check it back in via the web client.

  1. Navigate to the SharePoint document library in your web browser.
  2. Look for the file throwing the error. A small red arrow on the file icon indicates it is checked out.
  3. Hover over the file, click the three vertical dots (Show actions), select More, and then click Check in.
  4. In the dialog box, add a version comment (optional) and click Check in.
    • Note: If you want to discard your changes and release the lock, select Discard checkout instead.

Step 2: Complete Mandatory Metadata Columns

If the file is checked out because of missing properties:

  1. In the document library, select the affected file.
  2. Click the Open details pane icon (circle with an “i”) in the top right.
  3. Look for fields highlighted in red or marked with warning labels.
  4. Input the missing required information.
  5. SharePoint will automatically save the properties and allow you to check in the file.

Step 3: Modify Library Checkout Settings (Administrators Only)

If your team does not strictly require check-out functionality, disable it to prevent sync blocks.

  1. Navigate to the SharePoint document library.
  2. Click the Gear (Settings) icon and select Library settings > More library settings.
  3. Under General Settings, click Versioning settings.
  4. Scroll down to the Require Check Out section.
  5. Select No for “Require documents to be checked out before they can be edited”.
  6. Click OK.

Step 4: Reset the OneDrive Sync Client

If the sync client is stuck attempting to upload files that are locked by checkout, you must reset the synchronization engine.

On Windows:

  1. Open the Run dialog by pressing Windows Key + R.
  2. Copy and paste the following command, then press Enter:
%localappdata%\Microsoft\OneDrive\onedrive.exe /reset

Note: If OneDrive does not restart automatically after 2 minutes, run:

%localappdata%\Microsoft\OneDrive\onedrive.exe

On macOS:

  1. Open the Terminal application.
  2. Execute the following command to run the OneDrive reset script:
# Execute OneDrive standalone reset command
open /Applications/OneDrive.app/Contents/Resources/ResetOneDriveAppStandalone.command

Summary Checklist

  • Check for a red arrow on the file icon in the SharePoint web interface.
  • Right-click the file in the browser and choose Check in or Discard checkout.
  • Open the Details Pane (“i” icon) and populate all required metadata fields.
  • In Versioning Settings, verify if “Require Check Out” can be disabled by an administrator.
  • Reset the OneDrive/SharePoint sync client using the terminal commands above.