Skip to main content
Server path: /documenso-templates | Type: Application | PCID required: Yes

Tools

ToolDescription
documenso_templates_field_create_template_fieldCreate template field
documenso_templates_field_create_template_fieldsCreate template fields
documenso_templates_field_delete_template_fieldDelete template field
documenso_templates_field_get_template_fieldGet template field
documenso_templates_field_update_template_fieldUpdate template field
documenso_templates_field_update_template_fieldsUpdate template fields
documenso_templates_recipient_create_template_recipientCreate template recipient
documenso_templates_recipient_create_template_recipientsCreate template recipients
documenso_templates_recipient_delete_template_recipientDelete template recipient
documenso_templates_recipient_get_template_recipientGet template recipient
documenso_templates_recipient_update_template_recipientUpdate template recipient
documenso_templates_recipient_update_template_recipientsUpdate template recipients
documenso_templates_template_create_document_from_templateUse template
documenso_templates_template_create_templateCreate template
documenso_templates_template_create_template_direct_linkCreate direct link
documenso_templates_template_create_template_temporaryCreate template
documenso_templates_template_delete_templateDelete template
documenso_templates_template_delete_template_direct_linkDelete direct link
documenso_templates_template_duplicate_templateDuplicate template
documenso_templates_template_find_templatesFind templates
documenso_templates_template_get_manyGet multiple templates
documenso_templates_template_get_template_by_idGet template
documenso_templates_template_toggle_template_direct_linkToggle direct link
documenso_templates_template_update_templateUpdate template

documenso_templates_field_create_template_field

Create template field Parameters:
ParameterTypeRequiredDefaultDescription
fieldobjectYesThe field value
templateIdnumberYesTemplate Id

documenso_templates_field_create_template_fields

Create template fields Parameters:
ParameterTypeRequiredDefaultDescription
fieldsany[]YesThe fields value
templateIdnumberYesTemplate Id

documenso_templates_field_delete_template_field

Delete template field Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdnumberYesField Id

documenso_templates_field_get_template_field

Get template field Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdnumberYesField Id

documenso_templates_field_update_template_field

Update template field Parameters:
ParameterTypeRequiredDefaultDescription
fieldobjectYesThe field value
templateIdnumberYesTemplate Id

documenso_templates_field_update_template_fields

Update template fields Parameters:
ParameterTypeRequiredDefaultDescription
fieldsany[]YesThe fields value
templateIdnumberYesTemplate Id

documenso_templates_recipient_create_template_recipient

Create template recipient Parameters:
ParameterTypeRequiredDefaultDescription
recipientobjectYesThe recipient value
templateIdnumberYesTemplate Id

documenso_templates_recipient_create_template_recipients

Create template recipients Parameters:
ParameterTypeRequiredDefaultDescription
recipientsobject[]YesThe recipients value
templateIdnumberYesTemplate Id

documenso_templates_recipient_delete_template_recipient

Delete template recipient Parameters:
ParameterTypeRequiredDefaultDescription
recipientIdnumberYesRecipient Id

documenso_templates_recipient_get_template_recipient

Get template recipient Parameters:
ParameterTypeRequiredDefaultDescription
recipientIdnumberYesRecipient Id

documenso_templates_recipient_update_template_recipient

Update template recipient Parameters:
ParameterTypeRequiredDefaultDescription
recipientobjectYesThe recipient value
templateIdnumberYesTemplate Id

documenso_templates_recipient_update_template_recipients

Update template recipients Parameters:
ParameterTypeRequiredDefaultDescription
recipientsobject[]YesThe recipients value
templateIdnumberYesTemplate Id

documenso_templates_template_create_document_from_template

Use template Parameters:
ParameterTypeRequiredDefaultDescription
attachmentsobject[]NoThe attachments value
customDocumentDataobject[]NoCustom Document Data
customDocumentDataIdstringNoCustom Document Data Id
distributeDocumentbooleanNoDistribute Document
externalIdstringNoExternal Id
folderIdstringNoFolder Id
formValuesobjectNoForm Values
overrideobjectNoThe override value
prefillFieldsany[]NoPrefill Fields
recipientsobject[]YesThe recipients value
templateIdnumberYesTemplate Id

documenso_templates_template_create_template

Create template Parameters:
ParameterTypeRequiredDefaultDescription
fileobjectYesThe file value
payloadobjectYesThe payload value

Create direct link Parameters:
ParameterTypeRequiredDefaultDescription
directRecipientIdnumberNoDirect Recipient Id
templateIdnumberYesTemplate Id

documenso_templates_template_create_template_temporary

Create template Parameters:
ParameterTypeRequiredDefaultDescription
attachmentsobject[]NoThe attachments value
externalIdstringNoExternal Id
folderIdstringNoFolder Id
globalAccessAuthstring[]NoGlobal Access Auth
globalActionAuthstring[]NoGlobal Action Auth
metaobjectNoThe meta value
publicDescriptionstringNoPublic Description
publicTitlestringNoPublic Title
titlestringYesThe title value
typestringNoThe type value
visibilitystringNoThe visibility value

documenso_templates_template_delete_template

Delete template Parameters:
ParameterTypeRequiredDefaultDescription
templateIdnumberYesTemplate Id

Delete direct link Parameters:
ParameterTypeRequiredDefaultDescription
templateIdnumberYesTemplate Id

documenso_templates_template_duplicate_template

Duplicate template Parameters:
ParameterTypeRequiredDefaultDescription
templateIdnumberYesTemplate Id

documenso_templates_template_find_templates

Find templates Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoThe search query.
pagenumberNoThe pagination page number, starts at 1.
perPagenumberNoThe number of items per page.
typestringNoFilter templates by type.
folderIdstringNoThe ID of the folder to filter templates by.

documenso_templates_template_get_many

Get multiple templates Parameters:
ParameterTypeRequiredDefaultDescription
templateIdsnumber[]YesTemplate Ids

documenso_templates_template_get_template_by_id

Get template Parameters:
ParameterTypeRequiredDefaultDescription
templateIdnumberYesTemplate Id

Toggle direct link Parameters:
ParameterTypeRequiredDefaultDescription
enabledbooleanYesThe enabled value
templateIdnumberYesTemplate Id

documenso_templates_template_update_template

Update template Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectNoThe data value
metaobjectNoThe meta value
templateIdnumberYesTemplate Id