Manage Proposaly workspaces, leads, recipients, notes and documents, and search its knowledge bases.
Explore 29 workflow actions for Proposaly, including account permissions and operation limits.
12 read actions17 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Add Document With Recipients
Write
Create a new document and attach one or more recipients (no reCAPTCHA/fingerprint required).
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add Lead With Recipients
Write
Create a new lead and recipients (no reCAPTCHA/fingerprint required).
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add Recipient
Write
Create a new recipient.
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create Document
Write
Create a New Document Creates a new document (proposal, agreement, or presentation) within the specified workspace.
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create New Lead
Write
Create a New Lead This endpoint allows for the creation of a new lead within a specified workspace.
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create Note
Write
Add a note to a document Creates a note on any non-bot document of your company (proposal, agreement, presentation, payment, card or lead).
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create Workspace
Write
Create a new workspace This endpoint provisions a brand new workspace (internally a Board) under the authenticated company.
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Document
Write
Delete a Document (Soft Delete) Marks an existing document's status as Deleted.
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Lead
Write
Delete a Lead (Soft Delete) Marks an existing lead's status as Deleted.
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Note
Write
Delete a note Permanently deletes a note (there is no trash or restore).
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Recipient
Write
Delete a Recipient (Soft Delete) Marks a recipient's status as Deleted.
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Duplicate Document
Write
Duplicate a Document Creates a duplicate of an existing document (proposal, agreement, or presentation) within the same workspace.
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get Documents
Read
Get Document Details Retrieve document details by specifying either a workspaceid (to fetch all documents within that workspace) or a specific documentid.
Permissions and limits
Account permissions
A Proposaly company API key
Get Knowledge Base Article
Read
Get Knowledge Base Article Fetch one active article: metadata plus the full content of its currently selected version.
Permissions and limits
Account permissions
A Proposaly company API key
Get Knowledge Bases
Read
Get Knowledge Bases Retrieve the company's active knowledge bases with their categories and active-article counts.
Permissions and limits
Account permissions
A Proposaly company API key
Get Leads
Read
Get Lead Details Retrieve details of leads by specifying either a workspaceid (to fetch all leads within that workspace) or a specific leadid.
Permissions and limits
Account permissions
A Proposaly company API key
Get Note
Read
Get a single note Returns one note by id, scoped to the document given in documentid.
Permissions and limits
Account permissions
A Proposaly company API key
Get Notes
Read
List the notes of a document Returns the document's notes newest first, paginated.
Permissions and limits
Account permissions
A Proposaly company API key
Get Quota
Read
Get API Quota This endpoint returns the current daily quota usage and limits for the calling API key.
Permissions and limits
Account permissions
A Proposaly company API key
Get Recipient Notification Preferences
Read
Retrieve the current notification preferences for a specific recipient.
Permissions and limits
Account permissions
A Proposaly company API key
Get Recipients
Read
Retrieve recipient information by documentid or recipientid.
Permissions and limits
Account permissions
A Proposaly company API key
Get Workspace Details
Read
Get Workspace Details.
Permissions and limits
Account permissions
A Proposaly company API key
Search Knowledge Base Articles
Read
Search Knowledge Base Articles Search active articles within one knowledge base.
Permissions and limits
Account permissions
A Proposaly company API key
Update Document
Write
Update an existing document (proposal/agreement/presentation).
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Lead
Write
Update an Existing Lead This endpoint updates details of an existing lead within a specified workspace.
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Note
Write
Update a note Partial update of a note's title and/or body; fields not sent are left unchanged.
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Recipient
Write
Update the details of an existing recipient.
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Recipient Notification Preferences
Write
Update the notification preferences for a specific recipient.
Permissions and limits
Account permissions
A Proposaly company API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Validate API Key
Read
Validate API Credentials A convenience endpoint to verify that the supplied Bearer token (Company API key) is valid and active.
Permissions and limits
Account permissions
A Proposaly company API key
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Proposaly. A saved workflow is not a completed provider action.