Bidsketch

bidsketch

Bidsketch is a proposal software that helps businesses create professional proposals quickly and efficiently.

Proposal & Invoice Management Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool to create a client. use when adding a new client record to bidsketch.

Parámetros de entrada

citystring
City in the client's address.
namestring
Client's full name or company name.
emailstringObligatorio
Client's primary email address.
notesstring
Notes about the client; quotes need not be escaped.
phonestring
Client's primary phone number.
statestring
State in the client's address.
countrystring
Country in the client's address.
websitestring
Client's website.
alt_phonestring
Client's alternate phone number.
last_namestringObligatorio
Client's last name if they are a person.
first_namestringObligatorio
Client's first name if they are a person.
postal_zipstring
Postal or ZIP code of the client's address.
other_contactobject
Secondary contact information for client creation.
address_field_onestring
First line of the client's address.
address_field_twostring
Second line of the client's address.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ClientBIDSKETCH_DELETE_CLIENTAcción

Tool 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

idintegerObligatorio
The unique identifier of the client to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete FeeBIDSKETCH_DELETE_FEEAcción

Tool 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_idintegerObligatorio
Unique ID of the fee to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ProposalBIDSKETCH_DELETE_PROPOSALAcción

Tool to delete a proposal and all its content. use after confirming the proposal id to prevent accidental deletions.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the proposal to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Proposal FeeBIDSKETCH_DELETE_PROPOSAL_FEEAcción

Tool 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_idintegerObligatorio
The ID of the fee to delete.
proposal_idintegerObligatorio
ID of the proposal containing the fee.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Proposal SectionBIDSKETCH_DELETE_PROPOSAL_SECTIONAcción

Tool 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_idintegerObligatorio
ID of the section to delete
proposal_idintegerObligatorio
ID of the proposal containing the section to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete SectionBIDSKETCH_DELETE_SECTIONAcción

Tool to delete a section. use when you need to permanently remove a saved section after confirming its id.

Parámetros de entrada

idintegerObligatorio
The ID of the section to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete WebhookBIDSKETCH_DELETE_WEBHOOKAcción

Tool to delete a webhook. use after obtaining the webhook id to remove it.

Parámetros de entrada

idintegerObligatorio
The ID of the webhook to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ClientBIDSKETCH_GET_CLIENTAcción

Tool to get a client by id. use when you need detailed client info after obtaining its id.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the client to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Client ProposalsBIDSKETCH_GET_CLIENT_PROPOSALSAcción

Tool to list proposals for a specific client. use after confirming the client id exists.

Parámetros de entrada

client_idintegerObligatorio
The ID of the client whose proposals to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ClientsBIDSKETCH_GET_CLIENTSAcción

Tool 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get FeeBIDSKETCH_GET_FEEAcción

Tool 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_idintegerObligatorio
Unique ID of the fee to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get FeesBIDSKETCH_GET_FEESAcción

Tool 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ProposalBIDSKETCH_GET_PROPOSALAcción

Tool to get a proposal by id. use when you need detailed information for a specific proposal after obtaining its id.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the proposal to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Proposal ContentBIDSKETCH_GET_PROPOSAL_CONTENTAcción

Tool 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_idintegerObligatorio
ID of the proposal to retrieve content for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Proposal FeeBIDSKETCH_GET_PROPOSAL_FEEAcción

Tool 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_idintegerObligatorio
ID of the fee to retrieve within the proposal.
proposal_idintegerObligatorio
ID of the proposal containing the fee.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Proposal FeesBIDSKETCH_GET_PROPOSAL_FEESAcción

Tool to list all fees for a proposal. use after confirming the proposal id exists; supports pagination.

Parámetros de entrada

pageinteger
Page number for pagination.
per_pageinteger
Number of items per page for pagination.
proposal_idintegerObligatorio
ID of the proposal to list fees for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ProposalsBIDSKETCH_GET_PROPOSALSAcción

Tool 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Proposal SectionBIDSKETCH_GET_PROPOSAL_SECTIONAcción

Tool to fetch a single proposal section. use when you need detailed information for a section after listing proposal sections.

Parámetros de entrada

section_idintegerObligatorio
ID of the specific section to retrieve
proposal_idintegerObligatorio
ID of the proposal containing the section to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Proposal SectionsBIDSKETCH_GET_PROPOSAL_SECTIONSAcción

Tool 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_idintegerObligatorio
ID of the proposal to retrieve sections for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Proposal StatsBIDSKETCH_GET_PROPOSAL_STATSAcción

Tool 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get SectionBIDSKETCH_GET_SECTIONAcción

Tool to fetch a section by id. use when you need detailed section information after confirming its id.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the section to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get SectionsBIDSKETCH_GET_SECTIONSAcción

Tool 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TemplatesBIDSKETCH_GET_TEMPLATESAcción

Tool 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create FeeBIDSKETCH_POST_FEEAcción

Tool 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

namestringObligatorio
Name of the fee to create.
unitstring
Unit label for custom fees. Required only when feetype is 'custom'.
amountnumberObligatorio
Fee amount. For fixed fees, this is a total; for calculated fees, this is the amount per unit.
feetypestringObligatorioenum
Type of fee. Must be one of 'fixed', 'hourly', 'monthly', 'yearly', or 'custom'.
fixedhourlymonthlyyearlycustom
categorystring
A fee category to group fees together.
quantityinteger
Quantity used for calculated fees.
descriptionstring
HTML formatted description for the fee.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Proposal FeeBIDSKETCH_POST_PROPOSAL_FEEAcción

Tool 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

namestringObligatorio
Title of the fee line item
unitstring
Unit label for calculated or custom fees. Required when feetype is 'custom'.
amountnumberObligatorio
Base amount per unit or total amount for fixed fees.
feetypestringObligatorioenum
Type of fee. Must be one of 'fixed', 'hourly', 'monthly', 'yearly', or 'custom'.
fixedhourlymonthlyyearlycustom
optionalboolean
Whether the fee is optional. Defaults to false.
quantityinteger
Quantity for calculated fees (e.g., hours).
descriptionstring
HTML formatted description for the fee.
proposal_idintegerObligatorio
ID of the proposal to which this fee will be added

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Proposal SectionBIDSKETCH_POST_PROPOSAL_SECTIONAcción

Tool to create a proposal section. use after confirming a proposal exists to add a new opening or closing section.

Parámetros de entrada

namestringObligatorio
Name/title of the section
descriptionstringObligatorio
HTML content of the section
proposal_idintegerObligatorio
ID of the proposal to which this section will be added
sectiontypestringObligatorioenum
Section placement: 'opening' or 'closing'
openingclosing

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create SectionBIDSKETCH_POST_SECTIONAcción

Tool 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

namestringObligatorio
The name of the section.
categorystring
A section category to group sections together.
descriptionstring
HTML-formatted content of the section.
sectiontypestringObligatorioenum
Specifies where the section will appear in a proposal. Must be 'opening' or 'closing'.
openingclosing

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create WebhookBIDSKETCH_POST_WEBHOOKAcción

Tool to create a webhook. use when your endpoint is ready to receive event notifications and must return http 200 ok.

Parámetros de entrada

eventstringObligatorioenum
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'.
client_createdproposal_createdproposal_sentproposal_viewedproposal_acceptedproposal_declinedproposal_accepted_or_declined
endpointstringObligatorio
Publicly 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ClientBIDSKETCH_PUT_CLIENTAcción

Tool to update a client. use when you need to modify existing client records with new data.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the client to update.
citystring
City in the client's address.
namestring
Client's full name or company name.
emailstring
Client's primary email address.
notesstring
Notes about the client; quotes need not be escaped.
phonestring
Client's primary phone number.
statestring
State in the client's address.
countrystring
Country in the client's address.
websitestring
Client's website.
alt_phonestring
Client's alternate phone number.
last_namestring
Client's last name if they are a person.
first_namestring
Client's first name if they are a person.
postal_zipstring
Postal or ZIP code of the client's address.
other_contactobject
Secondary contact information for client update.
address_field_onestring
First line of the client's address.
address_field_twostring
Second line of the client's address.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update FeeBIDSKETCH_PUT_FEEAcción

Tool to update a fee. use when you need to modify existing fee records with new data after verifying current values.

Parámetros de entrada

namestring
Name of the fee.
unitstring
Unit label for custom fees. Required only when feetype is 'custom'.
amountnumber
Fee amount. For fixed fees, this is total; for calculated fees, this is per-unit amount.
fee_idintegerObligatorio
Unique ID of the fee to update.
feetypestringenum
Type of fee. Must be one of 'fixed', 'hourly', 'monthly', 'yearly', or 'custom'.
fixedhourlymonthlyyearlycustom
categorystring
A fee category to group fees together.
quantityinteger
Quantity used for calculated fees.
descriptionstring
HTML-formatted description of the fee.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ProposalBIDSKETCH_PUT_PROPOSALAcción

Tool to update a specific proposal's details. use after retrieving a proposal to apply changes.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the proposal to update
taxnumber
Primary tax rate as a decimal percentage
namestring
Name/title of the proposal
tax2number
Secondary tax rate as a decimal percentage
currencystring
ISO 4217 currency code for the proposal
discountnumber
Discount rate as a decimal percentage
settingsobject
Nested settings for a proposal.
client_idinteger
ID of the client associated with the proposal
descriptionstring
Summary or description of the proposal
proposal_datestring
Date for the proposal (YYYY-MM-DD or datetime string)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Proposal FeeBIDSKETCH_PUT_PROPOSAL_FEEAcción

Tool 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

namestring
New name/title for the fee line item
unitstring
Unit label for custom fees; required when feetype is 'custom'
amountnumber
Updated amount or per-unit amount for the fee
fee_idintegerObligatorio
ID of the specific fee to update within the proposal
feetypestringenum
Type of fee; one of 'fixed', 'hourly', 'monthly', 'yearly', or 'custom'.
fixedhourlymonthlyyearlycustom
optionalboolean
Whether the fee is optional; leave blank to keep existing value
quantityinteger
Updated quantity for calculated fees
descriptionstring
Updated HTML description for the fee
proposal_idintegerObligatorio
ID of the proposal containing the fee to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Proposal SectionBIDSKETCH_PUT_PROPOSAL_SECTIONAcción

Tool 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

namestring
New name/title for the section
section_idintegerObligatorio
ID of the specific section to update
descriptionstring
New HTML content for the section
proposal_idintegerObligatorio
ID of the proposal containing the section to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update SectionBIDSKETCH_PUT_SECTIONAcción

Tool to update a section. use when you need to modify an existing section after confirming its id.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the section to update.
namestring
The name of the section.
categorystring
A section category to group sections together.
descriptionstring
HTML-formatted content of the section.
sectiontypestringenum
Specifies where the section will appear in a proposal. Must be 'opening' or 'closing'.
openingclosing

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not