Aspose.Cells Cloud API – Update (Set) Document Property

This REST API allows you to set or create a document property.

REST API

PUT https://api.aspose.cloud/v3.0/cells/{name}/documentproperties/{propertyName}

The following parameters are accepted:

Parameter Name	Type	Location	Description
name	string	path	The name of the Excel file.
propertyName	string	path	The name of the property to set.
property	object	body	JSON object that contains the new property value.
folder	string	query	The folder where the file is stored (optional).
storageName	string	query	The name of the storage (optional).

Document Property Object Schema

A Document Property is a name/value pair stored in the workbook’s metadata.

Name (string, required) – The property name (e.g., author).
Value (string, required) – The property value.
BuiltIn (string, optional) – Indicates whether the property is built‑in.
Link (object, optional) – Hyperlink information with fields Href, Rel, Title, and Type.

The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

You can use the cURL command‑line tool to access Aspose.Cells web services easily. The following example shows how to make a call to the Cloud API with cURL.

Request

curl -v "https://api.aspose.cloud/v3.0/cells/test.xlsx/documentproperties/author" \
-X PUT \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>" \
-d '{ "link": { "Href": "string", "Rel": "string", "Title": "string", "Type": "string" }, "Name": "author", "Value": "aspose", "BuiltIn": "string" }'

Response

{
  "Code": 200,
  "Status": "Created"
}

Error Handling

The API can return the following error responses. Handle them according to your application’s needs.

HTTP Status	Description	Example JSON Body
400	Bad request – missing or invalid parameters.	`{ "Code": 400, "Message": "Invalid request data." }`
401	Unauthorized – JWT token is missing or invalid.	`{ "Code": 401, "Message": "Authentication failed. Invalid or missing token." }`
404	Not found – the specified file or property does not exist.	`{ "Code": 404, "Message": "File or property not found." }`
500	Internal server error – unexpected condition on the server.	`{ "Code": 500, "Message": "An unexpected error occurred." }`

Cloud SDK Family

Using an SDK is the fastest way to develop against the API. An SDK handles low‑level details so you can focus on your project logic. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to call Aspose.Cells web services using various SDKs:

Get All Document Properties Update Metadata