Duplicate template into signing request
Changed onCreates a new signing request by duplicating an existing template, including all fields, users, reminders, and settings.
Seals. The new signing request carries the template's seal participants and the template fields that belong to them. This operation takes no seal_participants key. While multi-document editing is suspended, templates on the multi-document read-only path answer 409 MULTI_DOCUMENT_READ_ONLY. For templates on the single-document path during that suspension, a template seal follows the current version of its lineage: if that current version is revoked or deleted, or the lineage has no current version, the call answers 409 SEAL_UNAVAILABLE and creates nothing; a seal that the API key's company cannot see, or that is limited to a workspace other than the target workspace, is not copied and neither are its fields, and the 201 lists it in seal_participants as a dropped entry; if a seal would be kept while organization seals are not enabled, the call answers 503 SEALS_DISABLED; the 201 always carries seal_participants (an empty array when the template has no seal participants). For every company during normal operation, the copy attaches the template's stored seal version as it is, the 201 does not carry seal_participants, and a seal that was replaced, revoked or deleted since the template was saved fails when the request is sent.
Request
- Base URLhttps://api.firma.dev/functions/v1/signing-request-api
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Template ID to duplicate
Request body
Response
Template duplicated successfully into a new signing request
Example response
{
"status": "draft"
}Changes
- info
removed
subschema #2from the response bodyallOflist for the response status - info
added
subschema #2to the response bodyanyOflist for the response status - info
added the non-success response with the status
- info
added the optional property
to the response with the status
- info
- info
added the non-success response with the status
- info