We want to make your migration to Editor 2.0 as seamless as possible, especially when it comes to API and integrations. In this article, we'll cover points to consider so your API and current integrations remain unaffected.
- Document creation via API in Editor 2.0
Document creation via API in Editor 2.0
Our system automatically detects the workspace editor and creates a workspace-defined version of your document. If you have both editors enabled in your workspace, our system uses Editor 2.0 by default. However, you’re still able to set query parameter editor_ver=ev1 to create a document using Classic Editor. Changes in the request body are unnecessary.
Important note: Editor 2.0 has a new field called Merge field, which is used where Name would appear in Classic Editor to prepopulate a value in fields. In most cases, you won’t need to make any change since the Name parameter in Document Details response or webhook payload duplicates Merge field for Editor 2.0.
Create from a template
To start creating documents using Editor 2.0 instead of Classic Editor, first verify that you’re using a 2.0 template ID in your body request. If you’re migrating from Classic Editor, this means the request needs to be updated in your API call. If you have Editor 2.0 set as default for the workspace and the IDs between the two editors’ templates differ, we don’t restrict document creation from Classic Editor — even if you migrate. Our system defines the document editor based on the template, so no other changes are necessary.
Editor 2.0 has a new field setting called Merge field, which defines field names for API and Integrations. You can set a variable name without square brackets to the Merge field to pass values from integration variables. Alternatively, you can set a field name to map a value from the API request body and Zapier.
Important note: Classic Editor uses field setting Name to set fields values via API, and Title to set field values with Integrations.
Editor 2.0’s Placeholder parameter replaces Title in Classic Editor. The Title parameter will be empty in the Document Details response or webhook payload for Editor 2.0.
The Name parameter in Document Details or webhook payload populates from Merge field in Editor 2.0 and Name in Classic Editor.
The Signature, Initials, Payment Details, and Collect File fields don’t have a Merge field setting, and the Name parameter populates with the Placeholder parameter in Document Details and webhook payload.
Role parameter is not available in Editor 2.0.
Please be informed that all fields must be assigned in Editor 2.0 upon creation from a template via API. If you’re not sure all fields will be needed you can use a content placeholder and decide what content library items you want to place in the document. For more information see document creation documentation and detailed set-by-step guide.
While in Classic Editor you were able to upload images to text (up to three images) and image blocks, in Editor 2.0 you can only upload images to image blocks (one image per block). Image formats supported: GIF, JPG, PNG.
If you have permission to use one or more of our private APIs as a part of your workflow, please contact your account team with a list of those you use so we can assist with your migration. Because our private APIs are subject to change, there may be differences in structure or functionality between Classic Editor and Editor 2.0 endpoints. The quickest way to determine if a call is using our private API is to check whether the path matches the public/v1 structure shown here:
You will need to update the template associated with the Zap, this would include first creating a document from this template and then editing the first stage of the Zap with the new Template.
A new parameter in Editor 2.0, Placeholder, replaces the Title parameter from Classic Editor. The parameter Name populates from the field setting Name in Classic Editor and Merge field from Editor 2.0.
Important note: The template ID should be updated to the new version in Editor 2.0 if you’re optionally filtering triggers by template ID.
For a smooth migration, Editor 2.0’s field setting Merge field should match Title in Classic Editor.
Here’s how to migrate from our Classic Editor integration to our Editor 2.0 integration:
- Install the updated version of PandaDoc in Zendesk Sell marketplace.
- Start using the new PandaDoc extension in Zendesk Sell.
- Contact our support team about conducting a migration that will show previously created documents in the new PandaDoc extension.
- If your automation is based on document metadata, update your configuration to check zendesk_sell.deal_id metadata key instead of basecrm.deal_id.
Additionally, with the new integration, you can use zendesk_sell.company_id, zendesk_sell.lead_id, and zendesk_sell.contact_id when a document is created from a corresponding entity.