Replace Attachments in PDF

Replaces existing embedded attachments in a PDF with new files, and makes the modified PDF available for download.

Attachment Pairing:input_options.target_files and replace_files are paired by position — the first target_files entry is replaced by the first replace_files upload, and so on. If the two differ in length, only pairs up to the shorter one are applied.

Endpoint

post https://www.zohoapis.com/pdfeditor/api/v1/pdf/attachment/replace

Copy full URL

OAuth Scope

ZohoWriter.pdfEditor.ALLCopied!

curl --request POST \
  --url https://www.zohoapis.com/pdfeditor/api/v1/pdf/attachment/replace \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: multipart/form-data' \
  -F 'file=@file_path' \
  -F 'replace_files=updated-signed-form.pdf' \
  -F 'input_options={
  "target_files": [
    "signed-form.pdf"
  ]
}' \
  -F 'password=OpenSesame123'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) throws Exception{

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://www.zohoapis.com/pdfeditor/api/v1/pdf/attachment/replace"))
        .header("content-type", "multipart/form-data")
        .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = {
    'content-type': "multipart/form-data",
    'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/pdfeditor/api/v1/pdf/attachment/replace", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    list_of_text=List();
    file=invokeurl
    [
      url : "public fileURL link"
      type : GET
    ];
    list_of_text.add({"paramName":"file","content":file,"stringPart":"false"});
    list_of_text.add({"paramName":"replace_files","content":"updated-signed-form.pdf","stringPart":"true"});
    list_of_text.add({"paramName":"input_options","content":"[object Object]","stringPart":"true"});
    list_of_text.add({"paramName":"password","content":"OpenSesame123","stringPart":"true"});

    response = invokeUrl
    [
        url: "https://www.zohoapis.com/pdfeditor/api/v1/pdf/attachment/replace"
        type: POST
        headers: headersMap
        files: list_of_text
        connection: connection_name
    ]

    info response;

Request Body

multipart/form-data

filebinary(Required)

The source PDF whose attachments are replaced, uploaded directly or imported from a publicly accessible URL. The file must be no larger than 50 MB, contain no more than 400 pages, and have no page larger than 2,400 square inches. Its filename must not exceed 255 characters. Supported formats: pdf.

Example

quarterly-review.pdf

replace_filesarray[binary](Required)

One to 10 replacement files, uploaded directly — URL import is not supported for this field. Each file must be no larger than 20 MB and its filename must not exceed 255 characters. Each new attachment takes its replacement file's own uploaded filename, not its target's former name. Supported formats: pdf, jpg, jpeg, png.

Example

[
  "updated-signed-form.pdf"
]

Range :[1 .. 10]

input_optionsJSON Object(Required)

Configures which attachments are replaced.

Example

{
  "target_files": [
    "signed-form.pdf"
  ]
}

Show Sub-Attributes

target_filesarray[string](Required)

The existing attachments to replace, by filename. Each named file must already exist as an embedded attachment, or the request fails.

Example

[
  "signed-form.pdf"
]

Maximum Length :255Copied!

passwordstring(Optional)

The password to unlock the source PDF, if it is password-protected.

Example

OpenSesame123

Maximum Length :255Copied!

// Note: payload contains multiple type attributes

// type: file
file = quarterly-review.pdf

// type: array[file]
replace_files = [
  "updated-signed-form.pdf"
]

// type: object
input_options = {
  "target_files": [
    "signed-form.pdf"
  ]
}

// type: string
password = OpenSesame123

▼ Show full

  {
    "status": "inprogress",
    "status_check_url": "https://www.zohoapis.com/pdfeditor/api/v1/pdf/attachment/replace/job/3f65c7592a741d98e46bf310cbe678f574a1d51fce306a8d9b6430217e538acd"
  }

▼ Show full

Rate Limits

Duration1 minute

Threshold50

Lock Period5 minutes 30 seconds

Duration1 hour

Threshold200

Lock Period15 minutes

Duration1 day

Threshold2000

Lock Period2 hours

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.