Skip to main content
Bidsketch logo
  • Category: proposal & invoice management
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 38
  • Triggers: 0
  • Slug: BIDSKETCH
  • Version: 20261101_00

Tools

Slug: BIDSKETCH_CREATE_CLIENTTool to create a client. Use when adding a new client record to Bidsketch.

Input Parameters

string
City in the client’s address.
string
Client’s full name or company name.
string
required
Client’s primary email address.
string
Notes about the client; quotes need not be escaped.
string
Client’s primary phone number.
string
State in the client’s address.
string
Country in the client’s address.
string
Client’s website.
string
Client’s alternate phone number.
string
required
Client’s last name if they are a person.
string
required
Client’s first name if they are a person.
string
Postal or ZIP code of the client’s address.
object
Secondary contact information for client creation.
string
First line of the client’s address.
string
Second line of the client’s address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_CREATE_PROPOSALTool to create a new proposal. Use when you need to create a proposal for a client with a name, description, and other details.

Input Parameters

number
Tax as decimal (e.g., 0.1 for 10%).
string
required
The proposal’s name/title.
number
Secondary tax as decimal (e.g., 0.05 for 5%).
string
ISO currency code (e.g., USD, EUR, GBP).
number
Discount as decimal (e.g., 0.1 for 10%).
object
Settings for the proposal.
integer
required
The ID of the client for this proposal.
string
A summary of the proposal.
string
Date for the proposal in MM/DD/YYYY format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_DELETE_CLIENTTool to delete a client and all their proposals. Use when you want to permanently remove a client and its associated proposals from your account.

Input Parameters

integer
required
The unique identifier of the client to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_DELETE_FEETool to delete a fee. Use when a saved fee is no longer needed. Use after confirming this fee isn’t referenced in any live proposals.

Input Parameters

integer
required
Unique ID of the fee to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_DELETE_PROPOSALTool to delete a proposal and all its content. Use after confirming the proposal ID to prevent accidental deletions.

Input Parameters

integer
required
The unique identifier of the proposal to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_DELETE_PROPOSAL_FEETool to delete a proposal fee. Use when you need to remove an existing fee before finalizing or sending a proposal.

Input Parameters

integer
required
The ID of the fee to delete.
integer
required
ID of the proposal containing the fee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_DELETE_PROPOSAL_SECTIONTool to delete a proposal section. Use when you need to remove a section from a proposal after verifying its ID.

Input Parameters

integer
required
ID of the section to delete
integer
required
ID of the proposal containing the section to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_DELETE_SECTIONTool to delete a section. Use when you need to permanently remove a saved section after confirming its ID.

Input Parameters

integer
required
The ID of the section to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_DELETE_WEBHOOKDelete a webhook subscription by ID. A successful deletion returns an empty response; the tool raises an error if the request fails.

Input Parameters

integer
required
The unique ID of the webhook to permanently delete. This removes the webhook subscription and stops all future event notifications to the endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_CLIENTTool to get a client by ID. Use when you need detailed client info after obtaining its ID.

Input Parameters

integer
required
The unique identifier of the client to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_CLIENT_PROPOSALSTool to list proposals for a specific client. Use after confirming the client ID exists.

Input Parameters

integer
required
The ID of the client whose proposals to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_CLIENTSTool to retrieve all clients. Use when you need to list all clients on the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_FEETool to get a single fee. Use when you need detailed information about a fee by its ID after confirming its existence.

Input Parameters

integer
required
Unique ID of the fee to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_FEESTool to list all the fees for the account. Use when you need to fetch every saved fee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_PROPOSALTool to get a proposal by ID. Use when you need detailed information for a specific proposal after obtaining its ID.

Input Parameters

integer
required
The unique identifier of the proposal to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_PROPOSAL_CONTENTGet a proposal’s content, including opening sections, fees, closing sections, and associated client information.

Input Parameters

integer
required
ID of the proposal to retrieve content for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_PROPOSAL_FEETool to get a single fee item for a proposal. Use when you need detailed information about a specific fee before updating or displaying it.

Input Parameters

integer
required
ID of the fee to retrieve within the proposal.
integer
required
ID of the proposal containing the fee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_PROPOSAL_FEESTool to list all fees for a proposal. Use after confirming the proposal ID exists; supports pagination.

Input Parameters

integer
Page number for pagination.
integer
Number of items per page for pagination.
integer
required
ID of the proposal to list fees for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_PROPOSALSTool to retrieve all proposals for the account. Use when you need an overview of existing proposals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_PROPOSAL_SECTIONTool to fetch a single proposal section. Use when you need detailed information for a section after listing proposal sections.

Input Parameters

integer
required
ID of the specific section to retrieve
integer
required
ID of the proposal containing the section to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_PROPOSAL_SECTIONSTool to get all sections for a proposal. Use when you need to list opening or closing sections by proposal ID.

Input Parameters

integer
required
ID of the proposal to retrieve sections for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_PROPOSAL_STATSGet proposal statistics for your Bidsketch account. This endpoint retrieves the total count of proposals in your account, including all proposals regardless of their status (draft, sent, won, lost, or archived). Use this when you need to: - Get a quick overview of total proposal count - Track the number of proposals created over time - Display proposal statistics in dashboards or reports No parameters required - simply call this action to get the current proposal count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_SECTIONTool to fetch a section by ID. Use when you need detailed section information after confirming its ID.

Input Parameters

integer
required
The unique identifier of the section to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_SECTIONSRetrieves all reusable proposal sections saved to your Bidsketch account. Sections are text blocks that can be included in proposals, categorized as ‘opening’ (appear at the start) or ‘closing’ (appear at the end). Use this to browse available sections before adding them to proposals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_GET_TEMPLATESRetrieves all proposal templates saved in the account. Templates contain predefined sections, fees, and structure that can be used to create new proposals. Use this action to discover available templates before creating proposals or to display template options to users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_LIST_PROPOSAL_CLOSING_SECTIONSTool to get a collection of closing sections for a proposal. Closing sections appear at the end of the proposal. Use when you need to retrieve all closing sections for a specific proposal.

Input Parameters

integer
required
The unique ID of the proposal to retrieve closing sections for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_LIST_PROPOSAL_OPENING_SECTIONSTool to get a collection of opening sections for a proposal. Opening sections appear first in the proposal. Use when you need to retrieve all opening sections for a specific proposal.

Input Parameters

integer
required
The unique ID of the proposal to retrieve opening sections for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_POST_FEETool to create a fee. Use when you need to add a reusable fee to the account before adding it to a proposal. Ensure required fields are set (e.g., unit for custom fees).

Input Parameters

string
required
Name of the fee to create.
string
Unit label for custom fees. Required only when feetype is ‘custom’.
number
required
Fee amount. For fixed fees, this is a total; for calculated fees, this is the amount per unit.
string ("fixed" | "hourly" | "monthly" | "yearly" | "custom")
required
Type of fee. Must be one of ‘fixed’, ‘hourly’, ‘monthly’, ‘yearly’, or ‘custom’.
string
A fee category to group fees together.
integer
Quantity used for calculated fees.
string
required
HTML formatted description for the fee. Required by the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_POST_PROPOSAL_FEETool to create a proposal fee. Use after confirming the proposal exists to add a cost line item; require unit when feetype is custom.

Input Parameters

string
required
Title of the fee line item
string
Unit label for calculated or custom fees. Required when feetype is ‘custom’.
number
required
Base amount per unit or total amount for fixed fees.
string ("fixed" | "hourly" | "monthly" | "yearly" | "custom")
required
Type of fee. Must be one of ‘fixed’, ‘hourly’, ‘monthly’, ‘yearly’, or ‘custom’.
boolean
Whether the fee is optional. Defaults to false.
integer
Quantity for calculated fees (e.g., hours).
string
HTML formatted description for the fee.
integer
required
ID of the proposal to which this fee will be added

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_POST_PROPOSAL_SECTIONTool to create a proposal section. Use after confirming a proposal exists to add a new opening or closing section.

Input Parameters

string
required
Name/title of the section
string
required
HTML content of the section
integer
required
ID of the proposal to which this section will be added
string ("opening" | "closing")
required
Section placement: ‘opening’ or ‘closing’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_POST_SECTIONTool to create a section. Use when you need to add a new section to your account before including it in proposals.

Input Parameters

string
required
The name of the section.
string
A section category to group sections together.
string
required
HTML-formatted content of the section. This field is required by the API.
string ("opening" | "closing")
required
Specifies where the section will appear in a proposal. Must be ‘opening’ or ‘closing’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_POST_WEBHOOKCreate a webhook subscription in Bidsketch to receive real-time notifications when specific events occur. Webhooks enable your application to receive immediate notifications when events happen in Bidsketch, such as when clients are created or proposals are sent, viewed, accepted, or declined. Your webhook endpoint must be publicly accessible and respond with HTTP 200 OK to webhook POST requests. Bidsketch will retry failed deliveries up to 20 times. Common use cases: - Sync client data to your CRM when a new client is created - Trigger workflows when proposals are sent or viewed - Update project management tools when proposals are accepted - Send notifications to your team when proposals are declined

Input Parameters

string ("client_created" | "proposal_created" | "proposal_sent" | "proposal_viewed" | "proposal_accepted" | "proposal_declined" | "proposal_accepted_or_declined")
required
Type of event to subscribe to. Supported values: ‘client_created’, ‘proposal_created’, ‘proposal_sent’, ‘proposal_viewed’, ‘proposal_accepted’, ‘proposal_declined’, or ‘proposal_accepted_or_declined’.
string
required
Publicly accessible URL to receive webhook POST callbacks. Endpoint must respond with HTTP 200 OK or Bidsketch will retry delivery up to 20 times.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_PUT_CLIENTTool to update a client. Use when you need to modify existing client records with new data.

Input Parameters

integer
required
The unique identifier of the client to update.
string
City in the client’s address.
string
Client’s full name or company name.
string
Client’s primary email address.
string
Notes about the client; quotes need not be escaped.
string
Client’s primary phone number.
string
State in the client’s address.
string
Country in the client’s address.
string
Client’s website.
string
Client’s alternate phone number.
string
Client’s last name if they are a person.
string
Client’s first name if they are a person.
string
Postal or ZIP code of the client’s address.
object
Secondary contact information for client update.
string
First line of the client’s address.
string
Second line of the client’s address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_PUT_FEETool to update a fee. Use when you need to modify existing fee records with new data after verifying current values.

Input Parameters

string
Name of the fee.
string
Unit label for custom fees. Required only when feetype is ‘custom’.
number
Fee amount. For fixed fees, this is total; for calculated fees, this is per-unit amount.
integer
required
Unique ID of the fee to update.
string ("fixed" | "hourly" | "monthly" | "yearly" | "custom")
Type of fee. Must be one of ‘fixed’, ‘hourly’, ‘monthly’, ‘yearly’, or ‘custom’.
string
A fee category to group fees together.
integer
Quantity used for calculated fees.
string
HTML-formatted description of the fee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_PUT_PROPOSALTool to update a specific proposal’s details. Use after retrieving a proposal to apply changes.

Input Parameters

integer
required
The unique identifier of the proposal to update
number
Primary tax rate as a decimal percentage
string
Name/title of the proposal
number
Secondary tax rate as a decimal percentage
string
ISO 4217 currency code for the proposal
number
Discount rate as a decimal percentage
object
Nested settings for a proposal.
integer
ID of the client associated with the proposal
string
Summary or description of the proposal
string
Date for the proposal (YYYY-MM-DD or datetime string)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_PUT_PROPOSAL_FEETool to update a proposal fee. Use when modifying specific properties of an existing fee within a proposal after verifying its existence.

Input Parameters

string
New name/title for the fee line item
string
Unit label for custom fees; required when feetype is ‘custom’
number
Updated amount or per-unit amount for the fee
integer
required
ID of the specific fee to update within the proposal
string ("fixed" | "hourly" | "monthly" | "yearly" | "custom")
Type of fee; one of ‘fixed’, ‘hourly’, ‘monthly’, ‘yearly’, or ‘custom’.
boolean
Whether the fee is optional; leave blank to keep existing value
integer
Updated quantity for calculated fees
string
Updated HTML description for the fee
integer
required
ID of the proposal containing the fee to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_PUT_PROPOSAL_SECTIONTool to update a proposal section. Use when you need to modify the name or content of an existing section after verifying its existence.

Input Parameters

string
New name/title for the section
integer
required
ID of the specific section to update
string
New HTML content for the section
integer
required
ID of the proposal containing the section to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIDSKETCH_PUT_SECTIONTool to update a section. Use when you need to modify an existing section after confirming its ID.

Input Parameters

integer
required
The unique identifier of the section to update.
string
The name of the section.
string
A section category to group sections together.
string
HTML-formatted content of the section.
string ("opening" | "closing")
Specifies where the section will appear in a proposal. Must be ‘opening’ or ‘closing’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not