Bidsketch
bidsketchBidsketch is a proposal software that helps businesses create professional proposals quickly and efficiently.
Acciones disponibles (35)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create ClientBIDSKETCH_CREATE_CLIENTAcciónTool to create a client. use when adding a new client record to bidsketch.
BIDSKETCH_CREATE_CLIENTAcciónTool to create a client. use when adding a new client record to bidsketch.
Parámetros de entrada
citystringCity in the client's address.
namestringClient's full name or company name.
emailstringObligatorioClient's primary email address.
notesstringNotes about the client; quotes need not be escaped.
phonestringClient's primary phone number.
statestringState in the client's address.
countrystringCountry in the client's address.
websitestringClient's website.
alt_phonestringClient's alternate phone number.
last_namestringObligatorioClient's last name if they are a person.
first_namestringObligatorioClient's first name if they are a person.
postal_zipstringPostal or ZIP code of the client's address.
other_contactobjectSecondary contact information for client creation.
address_field_onestringFirst line of the client's address.
address_field_twostringSecond line of the client's address.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ClientBIDSKETCH_DELETE_CLIENTAcciónTool to delete a client and all their proposals. use when you want to permanently remove a client and its associated proposals from your account.
BIDSKETCH_DELETE_CLIENTAcciónTool to delete a client and all their proposals. use when you want to permanently remove a client and its associated proposals from your account.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the client to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete FeeBIDSKETCH_DELETE_FEEAcciónTool 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.
BIDSKETCH_DELETE_FEEAcciónTool 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.
Parámetros de entrada
fee_idintegerObligatorioUnique ID of the fee to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ProposalBIDSKETCH_DELETE_PROPOSALAcciónTool to delete a proposal and all its content. use after confirming the proposal id to prevent accidental deletions.
BIDSKETCH_DELETE_PROPOSALAcciónTool to delete a proposal and all its content. use after confirming the proposal id to prevent accidental deletions.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the proposal to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Proposal FeeBIDSKETCH_DELETE_PROPOSAL_FEEAcciónTool to delete a proposal fee. use when you need to remove an existing fee before finalizing or sending a proposal.
BIDSKETCH_DELETE_PROPOSAL_FEEAcciónTool to delete a proposal fee. use when you need to remove an existing fee before finalizing or sending a proposal.
Parámetros de entrada
fee_idintegerObligatorioThe ID of the fee to delete.
proposal_idintegerObligatorioID of the proposal containing the fee.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Proposal SectionBIDSKETCH_DELETE_PROPOSAL_SECTIONAcciónTool to delete a proposal section. use when you need to remove a section from a proposal after verifying its id.
BIDSKETCH_DELETE_PROPOSAL_SECTIONAcciónTool to delete a proposal section. use when you need to remove a section from a proposal after verifying its id.
Parámetros de entrada
section_idintegerObligatorioID of the section to delete
proposal_idintegerObligatorioID of the proposal containing the section to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SectionBIDSKETCH_DELETE_SECTIONAcciónTool to delete a section. use when you need to permanently remove a saved section after confirming its id.
BIDSKETCH_DELETE_SECTIONAcciónTool to delete a section. use when you need to permanently remove a saved section after confirming its id.
Parámetros de entrada
idintegerObligatorioThe ID of the section to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete WebhookBIDSKETCH_DELETE_WEBHOOKAcciónTool to delete a webhook. use after obtaining the webhook id to remove it.
BIDSKETCH_DELETE_WEBHOOKAcciónTool to delete a webhook. use after obtaining the webhook id to remove it.
Parámetros de entrada
idintegerObligatorioThe ID of the webhook to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ClientBIDSKETCH_GET_CLIENTAcciónTool to get a client by id. use when you need detailed client info after obtaining its id.
BIDSKETCH_GET_CLIENTAcciónTool to get a client by id. use when you need detailed client info after obtaining its id.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the client to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Client ProposalsBIDSKETCH_GET_CLIENT_PROPOSALSAcciónTool to list proposals for a specific client. use after confirming the client id exists.
BIDSKETCH_GET_CLIENT_PROPOSALSAcciónTool to list proposals for a specific client. use after confirming the client id exists.
Parámetros de entrada
client_idintegerObligatorioThe ID of the client whose proposals to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ClientsBIDSKETCH_GET_CLIENTSAcciónTool to retrieve all clients. use when you need to list all clients on the account.
BIDSKETCH_GET_CLIENTSAcciónTool to retrieve all clients. use when you need to list all clients on the account.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get FeeBIDSKETCH_GET_FEEAcciónTool to get a single fee. use when you need detailed information about a fee by its id after confirming its existence.
BIDSKETCH_GET_FEEAcciónTool to get a single fee. use when you need detailed information about a fee by its id after confirming its existence.
Parámetros de entrada
fee_idintegerObligatorioUnique ID of the fee to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get FeesBIDSKETCH_GET_FEESAcciónTool to list all the fees for the account. use when you need to fetch every saved fee.
BIDSKETCH_GET_FEESAcciónTool to list all the fees for the account. use when you need to fetch every saved fee.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ProposalBIDSKETCH_GET_PROPOSALAcciónTool to get a proposal by id. use when you need detailed information for a specific proposal after obtaining its id.
BIDSKETCH_GET_PROPOSALAcciónTool to get a proposal by id. use when you need detailed information for a specific proposal after obtaining its id.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the proposal to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Proposal ContentBIDSKETCH_GET_PROPOSAL_CONTENTAcciónTool to get a proposal with all its content (sections and fees). use when you need a full proposal in one call.
BIDSKETCH_GET_PROPOSAL_CONTENTAcciónTool to get a proposal with all its content (sections and fees). use when you need a full proposal in one call.
Parámetros de entrada
proposal_idintegerObligatorioID of the proposal to retrieve content for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Proposal FeeBIDSKETCH_GET_PROPOSAL_FEEAcciónTool to get a single fee item for a proposal. use when you need detailed information about a specific fee before updating or displaying it.
BIDSKETCH_GET_PROPOSAL_FEEAcciónTool to get a single fee item for a proposal. use when you need detailed information about a specific fee before updating or displaying it.
Parámetros de entrada
fee_idintegerObligatorioID of the fee to retrieve within the proposal.
proposal_idintegerObligatorioID of the proposal containing the fee.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Proposal FeesBIDSKETCH_GET_PROPOSAL_FEESAcciónTool to list all fees for a proposal. use after confirming the proposal id exists; supports pagination.
BIDSKETCH_GET_PROPOSAL_FEESAcciónTool to list all fees for a proposal. use after confirming the proposal id exists; supports pagination.
Parámetros de entrada
pageintegerPage number for pagination.
per_pageintegerNumber of items per page for pagination.
proposal_idintegerObligatorioID of the proposal to list fees for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ProposalsBIDSKETCH_GET_PROPOSALSAcciónTool to retrieve all proposals for the account. use when you need an overview of existing proposals.
BIDSKETCH_GET_PROPOSALSAcciónTool to retrieve all proposals for the account. use when you need an overview of existing proposals.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Proposal SectionBIDSKETCH_GET_PROPOSAL_SECTIONAcciónTool to fetch a single proposal section. use when you need detailed information for a section after listing proposal sections.
BIDSKETCH_GET_PROPOSAL_SECTIONAcciónTool to fetch a single proposal section. use when you need detailed information for a section after listing proposal sections.
Parámetros de entrada
section_idintegerObligatorioID of the specific section to retrieve
proposal_idintegerObligatorioID of the proposal containing the section to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Proposal SectionsBIDSKETCH_GET_PROPOSAL_SECTIONSAcciónTool to get all sections for a proposal. use when you need to list opening or closing sections by proposal id.
BIDSKETCH_GET_PROPOSAL_SECTIONSAcciónTool to get all sections for a proposal. use when you need to list opening or closing sections by proposal id.
Parámetros de entrada
proposal_idintegerObligatorioID of the proposal to retrieve sections for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Proposal StatsBIDSKETCH_GET_PROPOSAL_STATSAcciónTool to get proposal statistics. use when you need the total count of proposals for the account.
BIDSKETCH_GET_PROPOSAL_STATSAcciónTool to get proposal statistics. use when you need the total count of proposals for the account.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SectionBIDSKETCH_GET_SECTIONAcciónTool to fetch a section by id. use when you need detailed section information after confirming its id.
BIDSKETCH_GET_SECTIONAcciónTool to fetch a section by id. use when you need detailed section information after confirming its id.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the section to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SectionsBIDSKETCH_GET_SECTIONSAcciónTool to list all sections. use when you need to retrieve saved sections for your account.
BIDSKETCH_GET_SECTIONSAcciónTool to list all sections. use when you need to retrieve saved sections for your account.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TemplatesBIDSKETCH_GET_TEMPLATESAcciónTool to list all proposal templates saved for the account. use when you need to fetch available templates before creating a new proposal.
BIDSKETCH_GET_TEMPLATESAcciónTool to list all proposal templates saved for the account. use when you need to fetch available templates before creating a new proposal.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create FeeBIDSKETCH_POST_FEEAcciónTool 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).
BIDSKETCH_POST_FEEAcciónTool 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).
Parámetros de entrada
namestringObligatorioName of the fee to create.
unitstringUnit label for custom fees. Required only when feetype is 'custom'.
amountnumberObligatorioFee amount. For fixed fees, this is a total; for calculated fees, this is the amount per unit.
feetypestringObligatorioenumType of fee. Must be one of 'fixed', 'hourly', 'monthly', 'yearly', or 'custom'.
fixedhourlymonthlyyearlycustomcategorystringA fee category to group fees together.
quantityintegerQuantity used for calculated fees.
descriptionstringHTML formatted description for the fee.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Proposal FeeBIDSKETCH_POST_PROPOSAL_FEEAcciónTool to create a proposal fee. use after confirming the proposal exists to add a cost line item; require unit when feetype is custom.
BIDSKETCH_POST_PROPOSAL_FEEAcciónTool to create a proposal fee. use after confirming the proposal exists to add a cost line item; require unit when feetype is custom.
Parámetros de entrada
namestringObligatorioTitle of the fee line item
unitstringUnit label for calculated or custom fees. Required when feetype is 'custom'.
amountnumberObligatorioBase amount per unit or total amount for fixed fees.
feetypestringObligatorioenumType of fee. Must be one of 'fixed', 'hourly', 'monthly', 'yearly', or 'custom'.
fixedhourlymonthlyyearlycustomoptionalbooleanWhether the fee is optional. Defaults to false.
quantityintegerQuantity for calculated fees (e.g., hours).
descriptionstringHTML formatted description for the fee.
proposal_idintegerObligatorioID of the proposal to which this fee will be added
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Proposal SectionBIDSKETCH_POST_PROPOSAL_SECTIONAcciónTool to create a proposal section. use after confirming a proposal exists to add a new opening or closing section.
BIDSKETCH_POST_PROPOSAL_SECTIONAcciónTool to create a proposal section. use after confirming a proposal exists to add a new opening or closing section.
Parámetros de entrada
namestringObligatorioName/title of the section
descriptionstringObligatorioHTML content of the section
proposal_idintegerObligatorioID of the proposal to which this section will be added
sectiontypestringObligatorioenumSection placement: 'opening' or 'closing'
openingclosing
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create SectionBIDSKETCH_POST_SECTIONAcciónTool to create a section. use when you need to add a new section to your account before including it in proposals.
BIDSKETCH_POST_SECTIONAcciónTool to create a section. use when you need to add a new section to your account before including it in proposals.
Parámetros de entrada
namestringObligatorioThe name of the section.
categorystringA section category to group sections together.
descriptionstringHTML-formatted content of the section.
sectiontypestringObligatorioenumSpecifies where the section will appear in a proposal. Must be 'opening' or 'closing'.
openingclosing
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create WebhookBIDSKETCH_POST_WEBHOOKAcciónTool to create a webhook. use when your endpoint is ready to receive event notifications and must return http 200 ok.
BIDSKETCH_POST_WEBHOOKAcciónTool to create a webhook. use when your endpoint is ready to receive event notifications and must return http 200 ok.
Parámetros de entrada
eventstringObligatorioenumType of event to subscribe to. Supported values: 'client_created', 'proposal_created', 'proposal_sent', 'proposal_viewed', 'proposal_accepted', 'proposal_declined', or 'proposal_accepted_or_declined'.
client_createdproposal_createdproposal_sentproposal_viewedproposal_acceptedproposal_declinedproposal_accepted_or_declinedendpointstringObligatorioPublicly accessible URL to receive webhook POST callbacks. Endpoint must respond with HTTP 200 OK or Bidsketch will retry delivery up to 20 times.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ClientBIDSKETCH_PUT_CLIENTAcciónTool to update a client. use when you need to modify existing client records with new data.
BIDSKETCH_PUT_CLIENTAcciónTool to update a client. use when you need to modify existing client records with new data.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the client to update.
citystringCity in the client's address.
namestringClient's full name or company name.
emailstringClient's primary email address.
notesstringNotes about the client; quotes need not be escaped.
phonestringClient's primary phone number.
statestringState in the client's address.
countrystringCountry in the client's address.
websitestringClient's website.
alt_phonestringClient's alternate phone number.
last_namestringClient's last name if they are a person.
first_namestringClient's first name if they are a person.
postal_zipstringPostal or ZIP code of the client's address.
other_contactobjectSecondary contact information for client update.
address_field_onestringFirst line of the client's address.
address_field_twostringSecond line of the client's address.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update FeeBIDSKETCH_PUT_FEEAcciónTool to update a fee. use when you need to modify existing fee records with new data after verifying current values.
BIDSKETCH_PUT_FEEAcciónTool to update a fee. use when you need to modify existing fee records with new data after verifying current values.
Parámetros de entrada
namestringName of the fee.
unitstringUnit label for custom fees. Required only when feetype is 'custom'.
amountnumberFee amount. For fixed fees, this is total; for calculated fees, this is per-unit amount.
fee_idintegerObligatorioUnique ID of the fee to update.
feetypestringenumType of fee. Must be one of 'fixed', 'hourly', 'monthly', 'yearly', or 'custom'.
fixedhourlymonthlyyearlycustomcategorystringA fee category to group fees together.
quantityintegerQuantity used for calculated fees.
descriptionstringHTML-formatted description of the fee.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ProposalBIDSKETCH_PUT_PROPOSALAcciónTool to update a specific proposal's details. use after retrieving a proposal to apply changes.
BIDSKETCH_PUT_PROPOSALAcciónTool to update a specific proposal's details. use after retrieving a proposal to apply changes.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the proposal to update
taxnumberPrimary tax rate as a decimal percentage
namestringName/title of the proposal
tax2numberSecondary tax rate as a decimal percentage
currencystringISO 4217 currency code for the proposal
discountnumberDiscount rate as a decimal percentage
settingsobjectNested settings for a proposal.
client_idintegerID of the client associated with the proposal
descriptionstringSummary or description of the proposal
proposal_datestringDate for the proposal (YYYY-MM-DD or datetime string)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Proposal FeeBIDSKETCH_PUT_PROPOSAL_FEEAcciónTool to update a proposal fee. use when modifying specific properties of an existing fee within a proposal after verifying its existence.
BIDSKETCH_PUT_PROPOSAL_FEEAcciónTool to update a proposal fee. use when modifying specific properties of an existing fee within a proposal after verifying its existence.
Parámetros de entrada
namestringNew name/title for the fee line item
unitstringUnit label for custom fees; required when feetype is 'custom'
amountnumberUpdated amount or per-unit amount for the fee
fee_idintegerObligatorioID of the specific fee to update within the proposal
feetypestringenumType of fee; one of 'fixed', 'hourly', 'monthly', 'yearly', or 'custom'.
fixedhourlymonthlyyearlycustomoptionalbooleanWhether the fee is optional; leave blank to keep existing value
quantityintegerUpdated quantity for calculated fees
descriptionstringUpdated HTML description for the fee
proposal_idintegerObligatorioID of the proposal containing the fee to update
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Proposal SectionBIDSKETCH_PUT_PROPOSAL_SECTIONAcciónTool to update a proposal section. use when you need to modify the name or content of an existing section after verifying its existence.
BIDSKETCH_PUT_PROPOSAL_SECTIONAcciónTool to update a proposal section. use when you need to modify the name or content of an existing section after verifying its existence.
Parámetros de entrada
namestringNew name/title for the section
section_idintegerObligatorioID of the specific section to update
descriptionstringNew HTML content for the section
proposal_idintegerObligatorioID of the proposal containing the section to update
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update SectionBIDSKETCH_PUT_SECTIONAcciónTool to update a section. use when you need to modify an existing section after confirming its id.
BIDSKETCH_PUT_SECTIONAcciónTool to update a section. use when you need to modify an existing section after confirming its id.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the section to update.
namestringThe name of the section.
categorystringA section category to group sections together.
descriptionstringHTML-formatted content of the section.
sectiontypestringenumSpecifies where the section will appear in a proposal. Must be 'opening' or 'closing'.
openingclosing
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not