/documenso-documents | Type: Application | PCID required: Yes
Tools
documenso_documents_document_attachment_create
Create attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | The data value |
documentId | number | Yes | — | Document Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"label": {
"type": "string",
"description": "The label value"
},
"data": {
"type": "string",
"description": "The data value"
}
},
"required": [
"label",
"data"
]
},
"documentId": {
"type": "number",
"description": "Document Id"
}
},
"required": [
"PCID",
"data",
"documentId"
]
}
documenso_documents_document_attachment_delete
Delete attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
documenso_documents_document_attachment_find
Find attachments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
}
},
"required": [
"PCID",
"documentId"
]
}
documenso_documents_document_attachment_update
Update attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | The data value |
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"label": {
"type": "string",
"description": "The label value"
},
"data": {
"type": "string",
"description": "The data value"
}
},
"required": [
"label",
"data"
]
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"data",
"id"
]
}
documenso_documents_document_create
Create document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file | object | Yes | — | The file value |
payload | object | Yes | — | The payload value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"file": {
"description": "The file value"
},
"payload": {
"type": "object",
"description": "The payload value",
"properties": {
"title": {
"type": "string",
"description": "The title value"
},
"externalId": {
"type": "string",
"description": "External Id"
},
"visibility": {
"type": "string",
"description": "The visibility value",
"enum": [
"EVERYONE",
"MANAGER_AND_ABOVE",
"ADMIN"
]
},
"globalAccessAuth": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACCOUNT",
"TWO_FACTOR_AUTH"
]
},
"description": "Global Access Auth"
},
"globalActionAuth": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACCOUNT",
"PASSKEY",
"TWO_FACTOR_AUTH",
"PASSWORD"
]
},
"description": "Global Action Auth"
},
"formValues": {
"type": "object",
"description": "Form Values"
},
"folderId": {
"type": "string",
"description": "Folder Id"
},
"recipients": {
"type": "array",
"items": {
"type": "object"
},
"description": "The recipients value"
},
"attachments": {
"type": "array",
"items": {
"type": "object"
},
"description": "The attachments value"
},
"meta": {
"type": "object",
"description": "The meta value"
}
},
"required": [
"title"
]
}
},
"required": [
"PCID",
"file",
"payload"
]
}
documenso_documents_document_delete
Delete document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
}
},
"required": [
"PCID",
"documentId"
]
}
documenso_documents_document_distribute
Distribute document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
meta | object | No | — | The meta value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"subject": {
"type": "string",
"description": "The subject value"
},
"message": {
"type": "string",
"description": "The message value"
},
"timezone": {
"type": "string",
"description": "Timezone identifier"
},
"dateFormat": {
"type": "string",
"description": "Date Format",
"enum": [
"yyyy-MM-dd hh:mm a",
"yyyy-MM-dd",
"dd/MM/yyyy",
"MM/dd/yyyy",
"yy-MM-dd",
"MMMM dd, yyyy",
"EEEE, MMMM dd, yyyy",
"dd/MM/yyyy hh:mm a",
"dd/MM/yyyy HH:mm",
"MM/dd/yyyy hh:mm a",
"MM/dd/yyyy HH:mm",
"dd.MM.yyyy",
"dd.MM.yyyy HH:mm",
"yyyy-MM-dd HH:mm",
"yy-MM-dd hh:mm a",
"yy-MM-dd HH:mm",
"yyyy-MM-dd HH:mm:ss",
"MMMM dd, yyyy hh:mm a",
"MMMM dd, yyyy HH:mm",
"EEEE, MMMM dd, yyyy hh:mm a",
"EEEE, MMMM dd, yyyy HH:mm",
"yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
]
},
"distributionMethod": {
"type": "string",
"description": "Distribution Method",
"enum": [
"EMAIL",
"NONE"
]
},
"redirectUrl": {
"type": "string",
"description": "Redirect Url"
},
"language": {
"type": "string",
"description": "The language value",
"enum": [
"de",
"en",
"fr",
"es",
"it",
"nl",
"pl",
"pt-BR",
"ja",
"ko",
"zh"
]
},
"emailId": {
"type": "string",
"description": "Email Id"
},
"emailReplyTo": {
"type": "string",
"description": "Email Reply To"
},
"emailSettings": {
"type": "object",
"description": "Email Settings"
}
}
}
},
"required": [
"PCID",
"documentId"
]
}
documenso_documents_document_download
Download document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | The ID of the document to download. |
version | string | No | — | The version of the document to download. “signed” returns the completed document with signatures, “original” returns the original uploaded document. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "The ID of the document to download."
},
"version": {
"type": "string",
"description": "The version of the document to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document.",
"enum": [
"original",
"signed"
]
}
},
"required": [
"PCID",
"documentId"
]
}
documenso_documents_document_download_beta
Download document (beta) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | The ID of the document to download. |
version | string | No | — | The version of the document to download. “signed” returns the completed document with signatures, “original” returns the original uploaded document. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "The ID of the document to download."
},
"version": {
"type": "string",
"description": "The version of the document to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document.",
"enum": [
"original",
"signed"
]
}
},
"required": [
"PCID",
"documentId"
]
}
documenso_documents_document_duplicate
Duplicate document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
}
},
"required": [
"PCID",
"documentId"
]
}
documenso_documents_document_find
Find documents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | The search query. |
page | number | No | — | The pagination page number, starts at 1. |
perPage | number | No | — | The number of items per page. |
templateId | number | No | — | Filter documents by the template ID used to create it. |
source | string | No | — | Filter documents by how it was created. |
status | string | No | — | Filter documents by the current status |
folderId | string | No | — | Filter documents by folder ID |
orderByColumn | string | No | — | Order By Column |
orderByDirection | string | No | — | Order By Direction |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"query": {
"type": "string",
"description": "The search query."
},
"page": {
"type": "number",
"description": "The pagination page number, starts at 1."
},
"perPage": {
"type": "number",
"description": "The number of items per page."
},
"templateId": {
"type": "number",
"description": "Filter documents by the template ID used to create it."
},
"source": {
"type": "string",
"description": "Filter documents by how it was created.",
"enum": [
"DOCUMENT",
"TEMPLATE",
"TEMPLATE_DIRECT_LINK"
]
},
"status": {
"type": "string",
"description": "Filter documents by the current status",
"enum": [
"DRAFT",
"PENDING",
"COMPLETED",
"REJECTED"
]
},
"folderId": {
"type": "string",
"description": "Filter documents by folder ID"
},
"orderByColumn": {
"type": "string",
"description": "Order By Column",
"enum": [
"createdAt"
]
},
"orderByDirection": {
"type": "string",
"description": "Order By Direction",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"PCID"
]
}
documenso_documents_document_get
Get document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
}
},
"required": [
"PCID",
"documentId"
]
}
documenso_documents_document_get_many
Get multiple documents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentIds | number[] | Yes | — | Document Ids |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentIds": {
"type": "array",
"items": {
"type": "number"
},
"description": "Document Ids"
}
},
"required": [
"PCID",
"documentIds"
]
}
documenso_documents_document_redistribute
Redistribute document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
recipients | number[] | Yes | — | The recipients value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
},
"recipients": {
"type": "array",
"items": {
"type": "number"
},
"description": "The recipients value"
}
},
"required": [
"PCID",
"documentId",
"recipients"
]
}
documenso_documents_document_update
Update document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | No | — | The data value |
documentId | number | Yes | — | Document Id |
meta | object | No | — | The meta value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"title": {
"type": "string",
"description": "The title value"
},
"externalId": {
"type": "string",
"description": "External Id"
},
"visibility": {
"type": "string",
"description": "The visibility value",
"enum": [
"EVERYONE",
"MANAGER_AND_ABOVE",
"ADMIN"
]
},
"globalAccessAuth": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACCOUNT",
"TWO_FACTOR_AUTH"
]
},
"description": "Global Access Auth"
},
"globalActionAuth": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACCOUNT",
"PASSKEY",
"TWO_FACTOR_AUTH",
"PASSWORD"
]
},
"description": "Global Action Auth"
},
"useLegacyFieldInsertion": {
"type": "boolean",
"description": "Use Legacy Field Insertion"
},
"folderId": {
"type": "string",
"description": "Folder Id"
}
}
},
"documentId": {
"type": "number",
"description": "Document Id"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"subject": {
"type": "string",
"description": "The subject value"
},
"message": {
"type": "string",
"description": "The message value"
},
"timezone": {
"type": "string",
"description": "Timezone identifier"
},
"dateFormat": {
"type": "string",
"description": "Date Format",
"enum": [
"yyyy-MM-dd hh:mm a",
"yyyy-MM-dd",
"dd/MM/yyyy",
"MM/dd/yyyy",
"yy-MM-dd",
"MMMM dd, yyyy",
"EEEE, MMMM dd, yyyy",
"dd/MM/yyyy hh:mm a",
"dd/MM/yyyy HH:mm",
"MM/dd/yyyy hh:mm a",
"MM/dd/yyyy HH:mm",
"dd.MM.yyyy",
"dd.MM.yyyy HH:mm",
"yyyy-MM-dd HH:mm",
"yy-MM-dd hh:mm a",
"yy-MM-dd HH:mm",
"yyyy-MM-dd HH:mm:ss",
"MMMM dd, yyyy hh:mm a",
"MMMM dd, yyyy HH:mm",
"EEEE, MMMM dd, yyyy hh:mm a",
"EEEE, MMMM dd, yyyy HH:mm",
"yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
]
},
"distributionMethod": {
"type": "string",
"description": "Distribution Method",
"enum": [
"EMAIL",
"NONE"
]
},
"signingOrder": {
"type": "string",
"description": "Signing Order",
"enum": [
"PARALLEL",
"SEQUENTIAL"
]
},
"allowDictateNextSigner": {
"type": "boolean",
"description": "Allow Dictate Next Signer"
},
"redirectUrl": {
"type": "string",
"description": "Redirect Url"
},
"language": {
"type": "string",
"description": "The language value",
"enum": [
"de",
"en",
"fr",
"es",
"it",
"nl",
"pl",
"pt-BR",
"ja",
"ko",
"zh"
]
},
"typedSignatureEnabled": {
"type": "boolean",
"description": "Typed Signature Enabled"
},
"uploadSignatureEnabled": {
"type": "boolean",
"description": "Upload Signature Enabled"
},
"drawSignatureEnabled": {
"type": "boolean",
"description": "Draw Signature Enabled"
},
"emailId": {
"type": "string",
"description": "Email Id"
},
"emailReplyTo": {
"type": "string",
"description": "Email Reply To"
},
"emailSettings": {
"type": "object",
"description": "Email Settings"
},
"envelopeExpirationPeriod": {
"description": "Envelope Expiration Period"
},
"reminderSettings": {
"type": "object",
"description": "Reminder Settings"
}
}
}
},
"required": [
"PCID",
"documentId"
]
}
documenso_documents_embedding_presign_create_embedding_presign_token
Create embedding presign token Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expiresIn | number | No | — | Expires In |
scope | string | No | — | The scope value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expiresIn": {
"type": "number",
"description": "Expires In"
},
"scope": {
"type": "string",
"description": "The scope value"
}
},
"required": [
"PCID"
]
}
documenso_documents_embedding_presign_verify_embedding_presign_token
Verify embedding presign token Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
scope | string | No | — | The scope value |
token | string | Yes | — | The token value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"scope": {
"type": "string",
"description": "The scope value"
},
"token": {
"type": "string",
"description": "The token value"
}
},
"required": [
"PCID",
"token"
]
}
documenso_documents_field_create_document_field
Create document field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
field | object | Yes | — | The field value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
},
"field": {
"description": "The field value"
}
},
"required": [
"PCID",
"documentId",
"field"
]
}
documenso_documents_field_create_document_fields
Create document fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
fields | any[] | Yes | — | The fields value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
},
"fields": {
"type": "array",
"description": "The fields value"
}
},
"required": [
"PCID",
"documentId",
"fields"
]
}
documenso_documents_field_delete_document_field
Delete document field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fieldId | number | Yes | — | Field Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fieldId": {
"type": "number",
"description": "Field Id"
}
},
"required": [
"PCID",
"fieldId"
]
}
documenso_documents_field_get_document_field
Get document field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fieldId | number | Yes | — | Field Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fieldId": {
"type": "number",
"description": "Field Id"
}
},
"required": [
"PCID",
"fieldId"
]
}
documenso_documents_field_update_document_field
Update document field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
field | object | Yes | — | The field value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
},
"field": {
"description": "The field value"
}
},
"required": [
"PCID",
"documentId",
"field"
]
}
documenso_documents_field_update_document_fields
Update document fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
fields | any[] | Yes | — | The fields value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
},
"fields": {
"type": "array",
"description": "The fields value"
}
},
"required": [
"PCID",
"documentId",
"fields"
]
}
documenso_documents_folder_create_folder
Create new folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name value |
parentId | string | No | — | Parent Id |
type | string | No | — | The type value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "The name value"
},
"parentId": {
"type": "string",
"description": "Parent Id"
},
"type": {
"type": "string",
"description": "The type value",
"enum": [
"DOCUMENT",
"TEMPLATE"
]
}
},
"required": [
"PCID",
"name"
]
}
documenso_documents_folder_delete_folder
Delete folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
folderId | string | Yes | — | Folder Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"folderId": {
"type": "string",
"description": "Folder Id"
}
},
"required": [
"PCID",
"folderId"
]
}
documenso_documents_folder_find_folders
Find folders Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | The search query. |
page | number | No | — | The pagination page number, starts at 1. |
perPage | number | No | — | The number of items per page. |
parentId | string | No | — | Parent Id |
type | string | No | — | The type value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"query": {
"type": "string",
"description": "The search query."
},
"page": {
"type": "number",
"description": "The pagination page number, starts at 1."
},
"perPage": {
"type": "number",
"description": "The number of items per page."
},
"parentId": {
"type": "string",
"description": "Parent Id"
},
"type": {
"type": "string",
"description": "The type value",
"enum": [
"DOCUMENT",
"TEMPLATE"
]
}
},
"required": [
"PCID"
]
}
documenso_documents_folder_update_folder
Update folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | The data value |
folderId | string | Yes | — | Folder Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"parentId": {
"type": "string",
"description": "Parent Id"
},
"visibility": {
"type": "string",
"description": "The visibility value",
"enum": [
"EVERYONE",
"MANAGER_AND_ABOVE",
"ADMIN"
]
},
"pinned": {
"type": "boolean",
"description": "The pinned value"
}
}
},
"folderId": {
"type": "string",
"description": "Folder Id"
}
},
"required": [
"PCID",
"data",
"folderId"
]
}
documenso_documents_recipient_create_document_recipient
Create document recipient Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
recipient | object | Yes | — | The recipient value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
},
"recipient": {
"type": "object",
"description": "The recipient value",
"properties": {
"email": {
"type": "string",
"description": "The email value"
},
"name": {
"type": "string",
"description": "The name value"
},
"role": {
"type": "string",
"description": "The role value",
"enum": [
"CC",
"SIGNER",
"VIEWER",
"APPROVER",
"ASSISTANT"
]
},
"signingOrder": {
"type": "number",
"description": "Signing Order"
},
"accessAuth": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACCOUNT",
"TWO_FACTOR_AUTH"
]
},
"description": "Access Auth"
},
"actionAuth": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACCOUNT",
"PASSKEY",
"TWO_FACTOR_AUTH",
"PASSWORD",
"EXPLICIT_NONE"
]
},
"description": "Action Auth"
}
},
"required": [
"email",
"name",
"role"
]
}
},
"required": [
"PCID",
"documentId",
"recipient"
]
}
documenso_documents_recipient_create_document_recipients
Create document recipients Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
recipients | object[] | Yes | — | The recipients value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
},
"recipients": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email value"
},
"name": {
"type": "string",
"description": "The name value"
},
"role": {
"type": "string",
"enum": [
"CC",
"SIGNER",
"VIEWER",
"APPROVER",
"ASSISTANT"
],
"description": "The role value"
},
"signingOrder": {
"type": "number",
"description": "Signing Order"
},
"accessAuth": {
"type": "array",
"items": {
"type": "string"
},
"description": "Access Auth"
},
"actionAuth": {
"type": "array",
"items": {
"type": "string"
},
"description": "Action Auth"
}
},
"required": [
"email",
"name",
"role"
]
},
"description": "The recipients value"
}
},
"required": [
"PCID",
"documentId",
"recipients"
]
}
documenso_documents_recipient_delete_document_recipient
Delete document recipient Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recipientId | number | Yes | — | Recipient Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"recipientId": {
"type": "number",
"description": "Recipient Id"
}
},
"required": [
"PCID",
"recipientId"
]
}
documenso_documents_recipient_get_document_recipient
Get document recipient Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recipientId | number | Yes | — | Recipient Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"recipientId": {
"type": "number",
"description": "Recipient Id"
}
},
"required": [
"PCID",
"recipientId"
]
}
documenso_documents_recipient_update_document_recipient
Update document recipient Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
recipient | object | Yes | — | The recipient value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
},
"recipient": {
"type": "object",
"description": "The recipient value",
"properties": {
"id": {
"type": "number",
"description": "The id value"
},
"email": {
"type": "string",
"description": "The email value"
},
"name": {
"type": "string",
"description": "The name value"
},
"role": {
"type": "string",
"description": "The role value",
"enum": [
"CC",
"SIGNER",
"VIEWER",
"APPROVER",
"ASSISTANT"
]
},
"signingOrder": {
"type": "number",
"description": "Signing Order"
},
"accessAuth": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACCOUNT",
"TWO_FACTOR_AUTH"
]
},
"description": "Access Auth"
},
"actionAuth": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACCOUNT",
"PASSKEY",
"TWO_FACTOR_AUTH",
"PASSWORD",
"EXPLICIT_NONE"
]
},
"description": "Action Auth"
}
},
"required": [
"id"
]
}
},
"required": [
"PCID",
"documentId",
"recipient"
]
}
documenso_documents_recipient_update_document_recipients
Update document recipients Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
recipients | object[] | Yes | — | The recipients value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentId": {
"type": "number",
"description": "Document Id"
},
"recipients": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The id value"
},
"email": {
"type": "string",
"description": "The email value"
},
"name": {
"type": "string",
"description": "The name value"
},
"role": {
"type": "string",
"enum": [
"CC",
"SIGNER",
"VIEWER",
"APPROVER",
"ASSISTANT"
],
"description": "The role value"
},
"signingOrder": {
"type": "number",
"description": "Signing Order"
},
"accessAuth": {
"type": "array",
"items": {
"type": "string"
},
"description": "Access Auth"
},
"actionAuth": {
"type": "array",
"items": {
"type": "string"
},
"description": "Action Auth"
}
},
"required": [
"id"
]
},
"description": "The recipients value"
}
},
"required": [
"PCID",
"documentId",
"recipients"
]
}