Skip to content

Export builder session

Request

Export a builder session as a ZIP file so you can save it and later create a new draft with import.

Use this when implementing document duplication (for example, after a document is finalized and you want to start a similar new document).

The ZIP contains session drafting data, including all attachments, values filled to the contract, and style customizations. It does not include integration redirect handlers (handlers).

Security
APIKey
Path
session_idstring, (uuid)required

The UUID of the session to export.

Example:7f3f5f62-2c69-7d4e-8a3d-9c0f0e2c5f3a
Headers
X-Participantstring, (uuid)required

The participant ID for the builder session export request.

Example:123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  https://api.builder.docue.com/api/builder/sessions/7f3f5f62-2c69-7d4e-8a3d-9c0f0e2c5f3a/export \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>' \
  -H 'X-Participant: 123e4567-e89b-12d3-a456-426614174000'

Responses

Successfully exported builder session as ZIP archive.

Bodyapplication/zip
string, (binary)(BuilderSessionExportFile)

ZIP archive containing exported builder session data.

Response
string