ERPNext HRMS icon

ERPNext HRMS

Work with ERPNext/Frappe HRMS v15-v16 documents and methods

Custom DocType → Update

AI-generated

Summary

Update a specified Custom DocType document by its name using the provided JSON payload and select the API version for the request.

Inputs

  • API Version — Select the Frappe REST API version to use: v1 (stable) or v2 (Frappe v16). Defaults to v1.
  • Custom DocType (required) — Specify the name of the Custom DocType to update (e.g., 'Job Applicant').
  • Document Name (required) — Provide the unique identifier (document name) of the Custom DocType document to update.
  • Data JSON (required) — Supply the document payload as JSON containing the fields to update and their new values.

Output shape

a single JSON object representing the updated document as returned by the ERPNext/Frappe API.

The update operation returns the updated document data from the ERPNext API. It uses HTTP PUT for API version v1 and PATCH for v2. Errors will throw an exception unless 'Continue On Fail' is enabled, in which case error details are returned per item.

Examples

Example 1: Update Job Applicant document with specific ID and new data

Set Resource to 'Custom DocType', enter 'Job Applicant' as Custom DocType, the target document's name as Document Name, choose API Version, and provide update fields in Data JSON.

Links

Discussion