Ejento APIs
V1
  • V2
  • V1
  1. Document APIs
Ejento APIs
V1
  • V2
  • V1
  • Overview
  • Endpoints
    • Chat APIs
      • Run Chat
      • Create Custom Instructions
      • Add Comment Feedback
      • Add Upvote Feedback
      • Add Downvote Feedback
      • Get Chat Thread
      • Get Thought Process
      • Get Supporting Content
      • Get All Agent Threads
    • Agent APIs
      • Get Recent Agents
      • Add to Recent Agents
      • Delete Recent Agent
      • Get Starred Agents
      • Delete Starred Agents
      • Get Agents by Team or User Team
      • Create a Review for an Agent
      • Get Agent Reviews
      • Update an Agent Review
      • Delete an Agent Review
      • Create Agent Chat
      • Get Agent Ratings
      • Toggle Rating
      • Create Agent Alias
      • Get All Agent Alias
      • Update Agent Alias
      • Get Agent Access Level
      • Update Agent Access Level
      • Get All Agents by Project
      • Get Agent Types
      • Update Agent Type
      • Get User Agent or User Agent Permission
    • Project APIs
      • Create New Project
      • Get All Projects
      • Get Project Details by ID
      • Edit Project By ID
      • Delete Project By ID
      • Add Recent Project
      • Get Recent Projects
      • Fetch Project Details
      • Add User to Project
      • Remove User from Project
      • Get User Projects For Team
    • Document APIs
      • Get Document By ID
        GET
      • Edit Document By ID
        PUT
      • Delete Document By ID
        DELETE
    • Corpus APIs
      • Get All Corpus
      • Create Corpus
      • Get Corpus by ID
      • Edit Corpus
      • Delete Corpus
      • Get Corpus Permissions
      • Create Corpus Permissions
      • Delete Corpus Permissions
      • Get Corpus Permission By User
      • Create Document In Corpus
      • Get All Documents From Corpus
      • Delete All Documents
      • Check Duplicate Documents
    • Evaluation APIs
      • Create Evaluation Test
      • Get All Evaluation Tests for an Agent
      • Update Evaluation Test
      • Get One Evaluation Test
      • Update Evaluation Status
      • Get Evaluation Dataset for an Agent
      • Get All Evaluation Datasets for an Agent
      • Create Evaluation Dataset
      • Update Evaluation Dataset
      • Delete Evaluation Dataset
      • Get Agent Queries
      • Get Dataset Queries
    • SharePoint APIs
      • Get SharePoint items by full path
      • Get a SharePoint item by its ID
      • Create a new SharePoint item
      • Edit SharePoint item
      • Delete a SharePoint item
    • User APIs
      • Get All Users
      • Get User By ID
      • Edit User By ID
      • Delete User by ID
      • Create User Permission
      • Get User Permission by ID
      • Edit User Permission by ID
      • Delete User Permission by ID
      • Batch Delete Users
    • Analytics APIs
      • Get Tokens by Date
      • Get Tokens by Segment
      • Get User Tokens
      • Get Agent Tokens
      • Get Team Tokens
      • Get Query Count by Date
      • Get Query Count by Segment
      • Get Total Count
      • Get Daily Chat Engagement
      • Get Weekly Chat Engagement
      • Get Monthly Chat Engagement
      • Get User Engagement
      • Get Daily Chatlog Tokens
      • Get Weekly Chatlog Tokens
      • Get Monthly Chatlog Tokens
      • Get Agent Engagement
      • Get Engagement by Team
      • Get Engagement by User
      • Get Recently Active Agents
      • Get Recent Users
    • Notification APIs
      • Send Notification To User
      • Read Notification By ID
  1. Document APIs

Edit Document By ID

PUT
/api/document/{document_id}
Document APIs
This endpoint allows authenticated users to update the details of a specific document using its ID.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/api/document/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user": {
        "id": 4,
        "email": "user@example.com"
    },
    "modified_by": "user@example.com",
    "type": "file",
    "source": "Updated_Document.txt",
    "tags": [
        "string"
    ],
    "is_deleted": false,
    "upload_from": "web",
    "step": "completed",
    "is_failed": false,
    "corpus": 484
}'
Response Response Example
{
    "document_id": 13212,
    "message": "Document updated successfully."
}

Request

Path Params
document_id
integer 
required
The ID of the document to update.
Body Params application/json
user
object 
optional
id
integer 
optional
User ID.
Example:
4
email
string 
optional
User email.
Example:
user@example.com
modified_by
string 
optional
The email of the person modifying the document.
Example:
user@example.com
type
string 
optional
Type of the document.
Example:
file
source
string 
optional
The name of the document.
Example:
Updated_Document.txt
tags
array[string]
optional
Tags associated with the document.
is_deleted
boolean 
optional
Flag indicating if the document is deleted.
Example:
false
upload_from
string 
optional
Source of upload.
Example:
web
step
string 
optional
Processing status of the document.
Example:
completed
is_failed
boolean 
optional
Indicates if document processing failed.
Example:
false
corpus
integer 
optional
ID of the associated corpus.
Example:
484
Examples

Responses

🟢200OK
application/json
Document updated successfully.
Body
document_id
integer 
optional
The ID of the updated document.
Example:
13212
message
string 
optional
Confirmation message.
Example:
Document updated successfully.
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Previous
Get Document By ID
Next
Delete Document By ID