Remove Attachment

Purpose

This API allows you to remove existing file attachments from a PDF document.

Quick Reference

Property	Value
Method	POST
Request URL (Download)	https://{zohoapis_domain}/pdfeditor/api/v1/pdf/attachment/remove
Request URL (Callback)	https://{zohoapis_domain}/pdfeditor/api/v1/pdf/attachment/remove/callback

Body Parameters

Parameter	Value	Mandatory/Optional	Description
file	File or String	Mandatory	Upload the PDF file from your local drive or desktop. If the PDF file is available via a publicly accessible web URL, you can provide the URL using the same parameter.
input_options	{ "target_files": ["old-report.pdf", "obsolete-image.png"] }	Optional	Specify the attachment filenames to remove. If omitted, all document-level attachments are removed.
password	String	Optional	If the input PDF is password protected, specify the password to unlock it.
callback	{ "invoke_url": "<callback_url>", "timeout": 60, "retry_interval": 60, "headers": { "header_name": "header_value" }, "http_method_type": "post" }	Mandatory for callback variant	Specify the callback delivery configuration for the /callback variant.

input_options Parameters

Parameter	Data Type	Possible Values	Default Value
target_files	JSON Array	Array of attachment filenames to remove	All attachments when input_options is omitted

callback Parameters

Parameter	Data Type	Possible Values	Default Value
invoke_url	String	URL. Maximum length: 300 characters.	–
timeout	Integer	10 to 120 seconds	60 seconds
retry_interval	Integer	60 to 28800 seconds	60 seconds
headers	JSON Object	Maximum 10 keys. Allowed characters for keys: alphabets, numbers, hyphen, underscore, dot. Maximum key length: 100. Maximum value length: 2500.	–
http_method_type	String	put, post	post

Notes and Limits

The maximum file size allowed for the input PDF is 50 MB.
The final output PDF must not exceed 250 MB.
Attachment filenames in target_files must match files present at the document root.
Associated highlight annotations and links pointing to removed attachments are automatically cleaned up.
To use this API, an OAuth token should be generated with the following scopes: ZohoWriter.pdfEditor.ALL

Possible Errors

Refer to the following pages for the list of possible errors for this API:

General Errors

Download Variant Sample Request

Copiedcurl --location --request POST "https://{zohoapis_domain}/pdfeditor/api/v1/pdf/attachment/remove" \
  --header "Authorization: Zoho-oauthtoken xxx.yyy.zzz" \
  --form 'file=@/Users/username/Documents/Master.pdf' \
  --form 'password="pdf_password"' \
  --form 'input_options={
    "target_files": ["old-report.pdf", "obsolete-image.png"]
  }'

Callback Variant Sample Request

Copiedcurl --location --request POST "https://{zohoapis_domain}/pdfeditor/api/v1/pdf/attachment/remove/callback" \
  --header "Authorization: Zoho-oauthtoken xxx.yyy.zzz" \
  --form 'file=@/Users/username/Documents/Master.pdf' \
  --form 'password="pdf_password"' \
  --form 'input_options={
    "target_files": ["obsolete.pdf"]
  }' \
  --form 'callback={"invoke_url": "https://www.example.com/v1/api/callback/savecallback", "timeout": 120, "retry_interval": 60, "http_method_type": "post"}'

Download Variant Sample Response

Copied{
  "status": "inprogress",
  "status_check_url": "https://pdf.zoho.com/pdfeditor/api/v1/pdf/attachment/remove/job/e9051e30fd7f0093cba4247d1f831e03e945a127bde429ed6e9ef3a703b15a6060b830256c650cb88a3f687773c33076"
}

Download Variant Success Response

Copied{
  "status": "success",
  "download_url": "https://pdf.zoho.com/pdfeditor/api/v1/pdf/attachment/remove/download/e4c7b2a9f1d5e8c3b6a9f2e5d8c1b4a7",
  "response_generated_time": 1780912499331
}

Callback Variant Sample Response

Copied{
  "status": "inprogress",
  "status_check_url": "https://pdf.zoho.com/pdfeditor/api/v1/pdf/attachment/remove/job/1d358192770dc68d173ca34b8f7c9dcb121ad0bf3d6307b7387be79e76dacf586f9d62cd253c26020f8c3dcf79d51b6b"
}

Callback Variant Success Response

Copied{
  "status": "success",
  "callback_response": {
    "invoked_time": 1780912655806,
    "http_status_code": 200,
    "message": {
      "download_url": "https://pdf.zoho.com/pdfeditor/api/v1/pdf/attachment/remove/download/e4c7b2a9f1d5e8c3b6a9f2e5d8c1b4a7",
      "response_generated_time": 1780912656237
    }
  }
}