← All action domains

Deal templates

5 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.

New deal template

deal_templates.createwrite

Save a starting point for new cards on a board: a title, value, starting stage, owner, custom fields and how many days out the expected close should be. Leave pipeline_id off to offer it on every board. Setting is_default makes the Add-deal form on that board open pre-filled with it, and clears the flag from any other template on the same board. Creates nothing on the board itself — it's a form pre-fill.

Parameters

FieldTypeRequiredDescription
namestringrequiredWhat to call the template in the picker — internal, not the deal's title.
pipeline_idstring (uuid)optionalBoard this template belongs to. Omit to offer it on every board.
titlestringoptionalThe deal title to pre-fill. May be a prefix the user finishes. Default: ""
value_centsintegeroptionalDeal value to pre-fill, in integer cents — $1,200.50 is 120050. Default: 0
currencystringoptionalISO currency code, e.g. 'usd'. Default: "usd"
stage_idstring (uuid)optionalStage a card starts in. Omit to use whichever column it's added from.
owner_idstring (uuid)optionalOrg member to assign the deal to.
close_in_daysintegeroptionalSets expected close this many days after the template is used. Relative on purpose, so it stays right over time. Omit to leave the date blank.
custommap of string → objectoptionalCustom field values to pre-fill, keyed by the org's deal custom-field keys. Team member fields (type "user") take a team member's email address or user id and store the user id; only current members are accepted.
is_defaultbooleanoptionalOpen the Add-deal form on this board pre-filled with this template. Ignored without a pipeline_id — a default only means something relative to one board. Default: false
project_template_idstring (uuid)optionalAlso create a project from this project template whenever a deal is made from this deal template — named after the deal, starting the day it is created, linked to it. Account admins only.

Example

curl -X POST https://app.chirply.io/api/v1/actions/deal_templates.create \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example"
  }'
Test with your API key

Over MCP the same operation is the tool deal_templates_create at https://app.chirply.io/api/mcp, same bearer token, same input.

Delete a deal template

deal_templates.deletewriteconfirm

Permanently delete a saved template. Deals already created from it are NOT affected — a template is only a form pre-fill. Cannot be undone.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

FieldTypeRequiredDescription
idstring (uuid)requiredThe template to delete.

Example

curl -X POST https://app.chirply.io/api/v1/actions/deal_templates.delete \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'
Test with your API key

Over MCP the same operation is the tool deal_templates_delete at https://app.chirply.io/api/mcp, same bearer token, same input.

List deal templates

deal_templates.listread

List the saved starting points for new cards. Pass pipeline_id to get exactly what the Add-deal form on that board offers: the templates tied to it plus the org-wide ones. Values come back as integer cents.

Parameters

FieldTypeRequiredDescription
limitintegeroptionalMax rows to return (1–100). Default: 25
offsetintegeroptionalRows to skip. Default: 0
pipeline_idstring (uuid)optionalOnly what this board offers — its own templates plus the ones set to every board.

Example

curl -X POST https://app.chirply.io/api/v1/actions/deal_templates.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'
Test with your API key

Over MCP the same operation is the tool deal_templates_list at https://app.chirply.io/api/mcp, same bearer token, same input.

Edit a deal template

deal_templates.updatewrite

Change a saved template. Omitted fields are left alone. Existing deals created from it are untouched — a template is a pre-fill, not a link. Setting is_default clears the flag from any other template on the same board.

Parameters

FieldTypeRequiredDescription
idstring (uuid)requiredThe template to edit.
namestringoptionalNew name for the picker.
pipeline_idstring (uuid) (or null)optionalMove it to another board, or null to offer it on every board.
titlestringoptionalNew deal title to pre-fill.
value_centsintegeroptionalNew value in integer cents.
currencystringoptionalISO currency code, e.g. 'usd'.
stage_idstring (uuid) (or null)optionalNew starting stage, or null to use whichever column it's added from.
owner_idstring (uuid) (or null)optionalNew owner, or null to leave unassigned.
close_in_daysinteger (or null)optionalDays from use to expected close, or null to leave the date blank.
custommap of string → objectoptionalReplacement custom field values, keyed by the org's deal custom-field keys. Team member fields (type "user") take a team member's email address or user id and store the user id; only current members are accepted.
is_defaultbooleanoptionalWhether the Add-deal form on its board opens pre-filled with this.
project_template_idstring (uuid) (or null)optionalProject template to create a project from whenever a deal is made from this template, or null to stop creating one. Account admins only.

Example

curl -X POST https://app.chirply.io/api/v1/actions/deal_templates.update \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'
Test with your API key

Over MCP the same operation is the tool deal_templates_update at https://app.chirply.io/api/mcp, same bearer token, same input.

Add a deal from a template

deal_templates.usewrite

Create a real deal on the board using a template as the starting point — the same thing as picking it under 'Start from' and submitting. The template's title, value, stage, owner, custom fields and 'close in N days' are applied, and anything you pass here overrides them. When the template is set to create a project, a project is also created from its project template — named after the deal, starting today, linked to the deal — and returned as `project` (or the reason it could not be). The template itself is unchanged; sends no messages.

Parameters

FieldTypeRequiredDescription
idstring (uuid)requiredThe template to start from.
pipeline_idstring (uuid)optionalBoard to create the deal on. Required for an every-board template; otherwise defaults to the template's own board.
titlestringoptionalOverrides the template's title.
stage_idstring (uuid)optionalOverrides the template's starting stage.
contact_idstring (uuid)optionalContact this deal belongs to.
company_idstring (uuid)optionalCompany this deal belongs to.
owner_idstring (uuid)optionalOverrides the template's owner.
value_centsintegeroptionalOverrides the template's value, in integer cents.

Example

curl -X POST https://app.chirply.io/api/v1/actions/deal_templates.use \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'
Test with your API key

Over MCP the same operation is the tool deal_templates_use at https://app.chirply.io/api/mcp, same bearer token, same input.

The machine-readable version of this page is GET https://app.chirply.io/api/v1/actions?domain=deal_templates — same operations, with full JSON Schemas. Authentication, errors and rate limits are covered in the API documentation home.