← All action domains

Stages

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.

Add a stage

stages.createwriteadmin only

Add a stage to the end of a pipeline. A stage with outcome 'won' or 'lost' closes any deal moved into it (stamping closed_at); 'in_progress' keeps deals open.

Parameters

FieldTypeRequiredDescription
pipeline_idstring (uuid)requiredThe pipeline to add the stage to.
namestringrequiredStage name, e.g. 'Negotiation'.
win_probabilityintegeroptionalChance a deal in this stage closes, 0–100. Default: 0
outcome"in_progress" | "won" | "lost"optionalWhat reaching this stage means for the deal: still open, won, or lost. Default: "in_progress"

Example

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

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

Delete a stage

stages.deletewriteconfirmadmin only

Permanently delete a stage from its pipeline. Deals in that column are NOT deleted — their stage is cleared, so they drop off the board until they're moved into another stage. 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 stage to delete.

Example

curl -X POST https://app.chirply.io/api/v1/actions/stages.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 stages_delete at https://app.chirply.io/api/mcp, same bearer token, same input.

List pipeline stages

stages.listread

List a pipeline's stages in board order, with each stage's win probability and whether it counts as won or lost. Omit pipeline_id for the default pipeline.

Parameters

FieldTypeRequiredDescription
pipeline_idstring (uuid)optionalWhose stages to list.

Example

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

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

Reorder stages

stages.reorderwriteadmin only

Set the left-to-right column order of a pipeline's stages. Pass the stage ids in the order you want them; every id must belong to the given pipeline. Deals stay in their stages.

Parameters

FieldTypeRequiredDescription
pipeline_idstring (uuid)requiredThe pipeline whose stages are being ordered.
stage_idsarray of (string (uuid))requiredStage ids in their new order, left to right.

Example

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

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

Edit a stage

stages.updatewriteadmin only

Rename a stage or change its win probability or outcome. Omitted fields are left alone. Changing the outcome does NOT restate deals already sitting in the stage — it applies the next time a deal moves in.

Parameters

FieldTypeRequiredDescription
idstring (uuid)requiredThe stage to edit.
namestringoptionalNew stage name.
win_probabilityintegeroptionalNew win probability, 0–100.
outcome"in_progress" | "won" | "lost"optionalNew meaning for the stage: in_progress, won, or lost.

Example

curl -X POST https://app.chirply.io/api/v1/actions/stages.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 stages_update 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=stages — same operations, with full JSON Schemas. Authentication, errors and rate limits are covered in the API documentation home.