POST /public/v1/documents/{id}/editing-sessions
Creates a new editing session for the Embedded Editor. The response includes an E-Token, which is required to open the document.
🚧 Important: The Embedded Editor can only open documents that have a
draftstatus.
Limitations
-
Single Active Session per User-Document Pair Only one editing session can be active at a time for a specific user and document. Creating a new session for the same user-document pair will automatically invalidate the previous one.
-
Weekly Session Cap A maximum of 250 editing sessions can be created for a single document per week. Any attempt to exceed this limit will result in a
403 Forbiddenerror.
Servers
- https://api.pandadoc.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Document ID |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
email |
String | Yes |
Email of the user to create the editing session for |
lifetime |
Integer | No |
Lifetime of the E-Token in seconds. Default value: 3600 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.