Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Attachments > Edit Attachment

Edit Attachment

Use the Edit Attachment REST request to make changes to the descriptive fields of an attachment, such as the description and the file name. You cannot change the actual content of the attached file in Zuora. If you need to change the actual content, you need to delete the attachment and add the updated file as a new attachment.

Request

  • Production: PUT https://api.zuora.com/rest/v1/attachments/{attachment-id}
  • API SandboxPUT https://apisandbox-api.zuora.com/rest/v1/attachments/{attachment-id}

Request Body

The request body must be in the JSON format.

filename optional File name of the attachment. The value should not contain the file extension. Only the file name without the extension can be edited.
description optional Description of the attachment.

Response

success Returns true if the request is successful. Otherwise, returns false.

Sample

Request

curl
-H "filename":"Image123.png"
-H "description":"Updated Image"
-H "Accept:application:json"
-X PUT https://api.zuora.com/rest/v1/attachments/8a8083e1545b706a015473153e4743f

Response

{
  "success": true
}
Last modified
10:37, 9 May 2016

Tags

This page has no custom tags.

Classifications

(not set)