Skip to main content
Capsule CRM logo
  • Category: crm
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? Yes
  • Tools: 109
  • Triggers: 0
  • Slug: CAPSULE_CRM
  • Version: 20261101_00

Tools

Slug: CAPSULE_CRM_ADD_PROJECT_PARTYTool to add a party (person or organisation) to a project in Capsule CRM. Use when you need to associate an additional contact with a specific project beyond the primary assigned party.

Input Parameters

integer
required
The unique identifier (integer ID) of the person or organisation to add to the project.
integer
required
The unique identifier (integer ID) of the project to add the party to.

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: CAPSULE_CRM_CREATE_CATEGORYTool to create a new task category in Capsule CRM. Use when you need to add a new category for organizing tasks with a specific name and color.

Input Parameters

string
required
The name of the category
string
required
The color of the category in hex format (e.g., #EF4444, #d1c21a, #444444). Must include the # prefix.

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: CAPSULE_CRM_CREATE_CUSTOM_FIELD_DEFINITIONTool to create a new custom field definition for parties, opportunities, or projects in Capsule CRM. Use when you need to extend standard entity fields with custom attributes.

Input Parameters

object
Reference to a data tag for grouping custom fields.
string
required
The label/name for this custom field that will be displayed in the UI.
string ("text" | "date" | "list" | "multiselectlist" | "boolean" | "number" | "link")
required
Data type of the custom field. Determines how values are stored and displayed.
string ("parties" | "opportunities" | "kases")
required
Entity type to create the custom field for. Use ‘parties’ for contacts, ‘opportunities’ for sales opportunities, or ‘kases’ for projects/cases.
array
List of valid values for ‘list’ or ‘multiselectlist’ field types. Required for those types, ignored for others.
boolean
Marks whether the field should be highlighted as critical or important in the UI.
string ("person" | "organisation")
Restricts applicability of party custom fields to person or organisation.
string
Extended explanation of the field’s purpose or usage instructions.

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: CAPSULE_CRM_CREATE_ENTRYTool to create a new note entry in Capsule CRM. Note: Only note type entries can be created via API. Emails and tasks can be viewed but not created through this endpoint. Use when you need to add a new note record linked to a party, opportunity, or project.

Input Parameters

object
Project (kase) to link the entry to. Exactly one of party, opportunity, or kase must be provided.
string
required
Type of entry. Only ‘note’ is supported for creation via API. Emails and tasks can be viewed but not created through this endpoint.
object
Party (person or organisation) to link the entry to. Exactly one of party, opportunity, or kase must be provided.
string
required
Text content of the entry.
string
Timestamp for the entry in ISO8601 format. Defaults to current time if not provided.
array
Array of attachment references with tokens from the Upload Attachment endpoint.
object
Opportunity to link the entry to. Exactly one of party, opportunity, or kase must be provided.
integer
Activity type ID. Common values: -1 for Note, -4 for Task completed.

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: CAPSULE_CRM_CREATE_LOST_REASONTool to create a new lost reason in Capsule CRM. Use when you need to add a new reason option for tracking why opportunities were lost. Lost reasons help categorize unsuccessful deals and can be included or excluded from conversion rate calculations.

Input Parameters

string
required
The name of the lost reason. This will appear in dropdown lists when marking opportunities as lost.
boolean
Whether to include this lost reason in conversion rate calculations. Set to true to include, false to exclude. If omitted, defaults to the system setting.

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: CAPSULE_CRM_CREATE_MILESTONECreate a new milestone in Capsule CRM with a name, probability, and optional description for a sales pipeline stage.

Input Parameters

string
required
Milestone identifier name. This is the stage name that will be displayed in the sales pipeline.
string
Detailed explanation of the milestone. Provides additional context about what this stage represents.
integer
required
Win probability percentage (0-100). Indicates the likelihood of closing deals at this stage. Required field. Note: Must be exactly 0 or 100 if the milestone represents a complete/closed stage.

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: CAPSULE_CRM_CREATE_OPPORTUNITYTool to create a new opportunity in Capsule CRM. Use when you need to track a potential sale with a party in the sales pipeline.

Input Parameters

string
required
The name/title of the opportunity. Required.
array
Tags to associate with the opportunity. Optional.
object
required
Party (person or organisation) associated with this opportunity. Required.
object
Value of the opportunity.
array
Custom field values for the opportunity. Optional.
array
List of tracks to associate with the opportunity. Optional.
integer
Duration value (used with durationBasis). Optional.
object
required
Milestone in the sales pipeline. Required by API validation.
string
Description of the opportunity. Optional.
integer
Probability percentage (0-100) of closing the deal. Optional.
string
Duration basis for the opportunity (e.g., ‘DAY’, ‘WEEK’, ‘MONTH’, ‘YEAR’). Optional.
string
Expected close date in ISO date format (YYYY-MM-DD). Optional.

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: CAPSULE_CRM_CREATE_OPPORTUNITY_PARTYTool to add a party (person or organisation) to an opportunity in Capsule CRM. Use when you need to associate an additional party with an existing opportunity.

Input Parameters

integer
required
The unique identifier (integer ID) of the party (person or organisation) to add to the opportunity.
integer
required
The unique identifier (integer ID) of the opportunity to add the party to.

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: CAPSULE_CRM_CREATE_PARTYTool to create a Party in Capsule CRM. Use when you have collected a person’s or organisation’s details and need to add a new record.

Input Parameters

string
Name for organisation when type='organisation'.
array
List of tags to apply to the party.
object
Assign team ID or clear by setting null.
string ("person" | "organisation")
required
Set to ‘person’ or ‘organisation’.
string
Free-text description.
object
Assign owner user ID or clear by setting null.
string
Person title, e.g. ‘Mr’ or ‘Ms’.
array
List of custom fields for the party.
string
Job title for the person.
string
Required when type='person'.
array
List of website URLs for the party.
array
List of postal addresses for the party.
string
Required when type='person'.
object
Link a person to an organisation by ID or name.
array
List of phone numbers for the party.
array
List of email addresses for the party.

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: CAPSULE_CRM_CREATE_PROJECTTool to create a new project (case) in Capsule CRM. Use when you need to create a project associated with a party (person or organisation) to track work or engagements.

Input Parameters

string
required
Name of the project. Required.
object
required
Party (person or organisation) to associate with the project. Required.
integer
ID of the project stage. Optional.
array
Custom field values for the project. Optional.
string
required
Project status. Common values: ‘OPEN’, ‘CLOSED’. Required.
array
List of tracks to associate with the project. Optional.
string
Description of the project. Optional.
object
Reference to an existing opportunity.
string
Expected close date in ISO date format (YYYY-MM-DD). Optional.

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: CAPSULE_CRM_CREATE_STAGETool to create a new stage in a board in Capsule CRM. Use when you need to add a new workflow stage to an existing board with a specific display order.

Input Parameters

string
required
The name of the stage. This identifies the stage within the board.
integer
required
The board ID to which this stage belongs. Must be a valid existing board ID.
string
A description of what the stage represents. Provides context for the stage’s purpose.
integer
required
The position of the stage in the board workflow. Lower numbers appear first.

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: CAPSULE_CRM_CREATE_TASKTool to create a new task in Capsule CRM. Use when you need to add a task with a description and due date, optionally linking it to parties, opportunities, or projects.

Input Parameters

object
Project (case) to associate with the task. Only one of party, opportunity, or kase can be set.
string
required
Due date in YYYY-MM-DD format (required)
object
User to assign as task owner (specify by ID)
object
Party (contact/organization) to associate with the task. Only one of party, opportunity, or kase can be set.
string
Additional details about the task
object
Set up recurring task with interval and frequency
string
Due time in HH:MM:SS format (e.g., ‘14:30:00’)
object
Task category to assign (specify by ID)
string
required
Short description of the task (required)
object
Opportunity to associate with the task. Only one of party, opportunity, or kase can be set.

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: CAPSULE_CRM_CREATE_TITLETool to create a new custom person title in Capsule CRM. Use when you need to add a new title option (e.g., ‘Madam’, ‘Sir’, ‘Dr’) for person records.

Input Parameters

object
required
Container object for the title data

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: CAPSULE_CRM_CREATE_TRACKTool to create a new track in Capsule CRM by applying a track definition to a project or opportunity. Use when you need to apply a predefined sequence of tasks to a specific entity.

Input Parameters

integer
The project (kase) ID to apply the track to. Either kase or opportunity must be provided, not both.
integer
required
The track definition ID to apply. Required.
string
Custom description for this track instance. Optional.
integer
The opportunity ID to apply the track to. Either kase or opportunity must be provided, not both.
string
required
The date to associate with the track, used to calculate task due dates. Format: YYYY-MM-DD. Required.

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: CAPSULE_CRM_CREATE_TRACK_DEFINITIONTool to create a new track definition in Capsule CRM. Use when you need to define a reusable sequence of tasks for business processes that can be applied to opportunities or projects.

Input Parameters

string
Comma-separated tags that will be automatically applied when the track is activated.
string ("START_DATE")
required
Determines the reference point for task timing. Currently only START_DATE is supported.
string ("OPPORTUNITY" | "KASE")
required
Specifies where the track can be applied. OPPORTUNITY: track is available for opportunities. KASE: track is available for projects.
string
required
Name/title of the track definition. This identifies the track template.
array
required
Collection of task definition templates. These define the tasks that will be created when the track is applied to an opportunity or project.

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: CAPSULE_CRM_DELETE_BOARDTool to delete (archive) a specific board in Capsule CRM. Use when you need to remove a board that is no longer needed.

Input Parameters

integer
required
The unique identifier (integer ID) of the board 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: CAPSULE_CRM_DELETE_CATEGORYTool to delete a category from Capsule CRM. Use when you need to remove a category that is no longer needed.

Input Parameters

string
required
The unique identifier of the category 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: CAPSULE_CRM_DELETE_CUSTOM_FIELD_DEFINITIONTool to delete a custom field definition from an entity type in Capsule CRM. This removes the field value from any parties, opportunities, or projects it was assigned to. Use when you need to permanently remove a custom field definition.

Input Parameters

string ("parties" | "opportunities" | "kases")
required
The entity type to delete the custom field definition from. Must be one of: parties, opportunities, or kases.
integer
required
The unique identifier (integer ID) of the custom field definition 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: CAPSULE_CRM_DELETE_ENTITY_TAGTool to delete a tag from an entity type (parties, opportunities, or kases) in Capsule CRM. Use when you need to remove a specific tag from all entities of a given type.

Input Parameters

string ("parties" | "opportunities" | "kases")
required
The entity type to delete the tag from. Must be one of: ‘parties’, ‘opportunities’, or ‘kases’.
integer
required
The unique numeric identifier of the tag to delete from the entity type.

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: CAPSULE_CRM_DELETE_ENTRYTool to delete an entry (note, email, or task) from Capsule CRM. Use when you need to remove an entry by its ID.

Input Parameters

integer
required
The unique ID of the entry 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: CAPSULE_CRM_DELETE_LOST_REASONTool to delete a lost reason from Capsule CRM. The deleted reason remains available for historical reporting but cannot be assigned to new opportunities.

Input Parameters

integer
required
The unique identifier (integer ID) of the lost reason 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: CAPSULE_CRM_DELETE_MILESTONETool to delete a specific milestone from Capsule CRM. Use when you need to remove a milestone that is no longer needed. Note: Cannot delete a milestone while it is being used on an opportunity.

Input Parameters

integer
required
The unique identifier (integer ID) of the milestone 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: CAPSULE_CRM_DELETE_OPPORTUNITYTool to delete an opportunity from Capsule CRM. The opportunity can be restored within 30 days via the web interface. Use when you need to remove an opportunity.

Input Parameters

integer
required
The unique identifier (integer ID) of the opportunity 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: CAPSULE_CRM_DELETE_OPPORTUNITY_PARTYTool to remove a party (person or organisation) from an opportunity in Capsule CRM. Use when you need to disassociate a contact from a specific opportunity.

Input Parameters

integer
required
The unique identifier (integer ID) of the person or organisation to remove from the opportunity.
integer
required
The unique identifier (integer ID) of the opportunity from which to remove the party.

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: CAPSULE_CRM_DELETE_PARTYDelete a specific party (person or organisation) from Capsule CRM. The result distinguishes deletion from a request accepted for processing.

Input Parameters

integer
required
The unique identifier (integer ID) of the party (person or organisation) 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: CAPSULE_CRM_DELETE_PROJECTTool to delete a project (case) from Capsule CRM. The project can be restored within 30 days via the web interface. Use when you need to remove a project.

Input Parameters

integer
required
The unique identifier (integer ID) of the project 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: CAPSULE_CRM_DELETE_PROJECT_PARTYTool to remove a party (person or organisation) from a project in Capsule CRM. Use when you need to disassociate a contact from a specific project.

Input Parameters

integer
required
The unique identifier (integer ID) of the person or organisation to remove from the project.
integer
required
The unique identifier (integer ID) of the project from which to remove the party.

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: CAPSULE_CRM_DELETE_STAGETool to delete a specific stage from a board in Capsule CRM. Use when you need to remove a stage that is no longer needed. Note: Cannot delete a stage while it is being used by open projects.

Input Parameters

integer
required
The unique identifier (integer ID) of the stage 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: CAPSULE_CRM_DELETE_TASKTool to delete a specific task from Capsule CRM. Use when you need to remove a task by its ID.

Input Parameters

integer
required
The unique identifier (integer ID) of the task 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: CAPSULE_CRM_DELETE_TITLETool to delete a specific title from Capsule CRM. Use when you need to remove a title that is no longer needed.

Input Parameters

integer
required
The unique identifier (integer ID) of the title 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: CAPSULE_CRM_DELETE_TRACKTool to delete a specific track from Capsule CRM. Use when you need to remove a track that is no longer needed.

Input Parameters

integer
required
The unique identifier (integer ID) of the track 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: CAPSULE_CRM_DELETE_TRACK_DEFINITIONTool to delete a specific track definition from Capsule CRM. Use when you need to remove a track definition that is no longer needed.

Input Parameters

integer
required
The unique identifier (integer ID) of the track definition 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: CAPSULE_CRM_GET_ACTIVITY_TYPETool to get a specific activity type by ID. Use when you need to retrieve details about a particular activity type including its name, icon, and whether it updates the last contacted date.

Input Parameters

integer
required
The unique ID of the activity type 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: CAPSULE_CRM_GET_ATTACHMENTTool to retrieve a specific attachment by ID from Capsule CRM. Returns the file content along with metadata (filename, content type). Use when you need to download an attachment that is associated with an entry (note, email, or completed task).

Input Parameters

integer
required
The unique identifier of the attachment 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: CAPSULE_CRM_GET_BOARDTool to get a specific board by ID from Capsule CRM. Use when you need to retrieve details of a particular board including its name, description, and timestamps.

Input Parameters

integer
required
The unique identifier of the board 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: CAPSULE_CRM_GET_CATEGORYTool to get a specific category by ID. Use when you need to retrieve details of a particular category including its name and colour.

Input Parameters

integer
required
The unique identifier of the category 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: CAPSULE_CRM_GET_CURRENT_USERTool to retrieve the current authenticated user’s details including id, username, name, locale, currency, status, timezone, lastLoginAt, and taskReminder settings. Use when you need to identify the current user or access their preferences and settings.

Input Parameters

array
List of additional data to embed. Use [‘party’] to include full party details (addresses, phone numbers, email addresses, etc.). Without this parameter, only basic party info is returned.

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: CAPSULE_CRM_GET_CUSTOM_FIELD_DEFINITIONTool to get a specific custom field definition by ID from Capsule CRM. Use when you need to retrieve details about a custom field including its type, options, and configuration.

Input Parameters

string ("parties" | "opportunities" | "kases")
required
Entity type - must be ‘parties’, ‘opportunities’, or ‘kases’.
integer
required
The unique identifier of the custom field definition.

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: CAPSULE_CRM_GET_ENTITY_TAGTool to retrieve a specific tag by ID for an entity type (parties, opportunities, or kases) in Capsule CRM. Use when you need details about a specific tag associated with an entity type.

Input Parameters

string ("parties" | "opportunities" | "kases")
required
The entity type to retrieve the tag from. Must be one of: ‘parties’, ‘opportunities’, or ‘kases’.
integer
required
The unique numeric identifier of the tag 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: CAPSULE_CRM_GET_ENTRYTool to retrieve a specific entry by ID. Use when you need to fetch details of a note, email, or task entry.

Input Parameters

integer
required
The unique ID of the entry 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: CAPSULE_CRM_GET_LOST_REASONTool to retrieve a specific lost reason by ID from Capsule CRM. Use when you need details about a particular lost reason, such as its name or conversion tracking status.

Input Parameters

integer
required
Numeric identifier for the specific lost reason 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: CAPSULE_CRM_GET_MILESTONETool to get a specific milestone by ID from Capsule CRM. Use when you need to retrieve details of a particular milestone including its name, description, completion status, and probability.

Input Parameters

integer
required
The unique identifier of the milestone 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: CAPSULE_CRM_GET_OPPORTUNITYRetrieve a specific opportunity by ID from Capsule CRM, including its value, milestone, and associated party when available.

Input Parameters

integer
required
The unique ID of the opportunity 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: CAPSULE_CRM_GET_PIPELINETool to get a specific pipeline by ID from Capsule CRM. Use when you need to retrieve details of a particular pipeline including its name, description, and timestamps.

Input Parameters

integer
required
The unique identifier of the pipeline 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: CAPSULE_CRM_GET_PROJECTTool to retrieve a specific project (case) by its ID from Capsule CRM. Use when you need detailed information about a single project.

Input Parameters

integer
required
The unique ID of the project 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: CAPSULE_CRM_GET_STAGETool to get a specific stage by ID from Capsule CRM. Use when you need to retrieve details of a particular stage including its name, description, board, and display order.

Input Parameters

integer
required
The unique identifier of the stage 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: CAPSULE_CRM_GET_TASKGet a specific task by ID, including its description, due date, status, and returned party and owner details.

Input Parameters

integer
required
The unique ID of the task 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: CAPSULE_CRM_GET_TRACKTool to get a specific track by ID. Use when you need to retrieve details of a track including its description, date, direction, and optionally its associated tasks.

Input Parameters

array
Array of strings to include related data. Allowed value: ‘task’ to include tasks associated with the track.
integer
required
The unique identifier of the track 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: CAPSULE_CRM_GET_TRACK_DEFINITIONTool to get a specific track definition by ID from Capsule CRM. Use when you need to retrieve details of a track definition including its description, capture rule, direction, and associated task definitions.

Input Parameters

integer
required
The unique identifier of the track definition 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: CAPSULE_CRM_GET_USERTool to get a specific user by ID. Use when you need to retrieve full details of a user including username, email preferences, timezone settings, and optionally their associated party information.

Input Parameters

array
List of additional data to embed. Use [‘party’] to include full party details (createdAt, updatedAt, owner, team, addresses, phoneNumbers, emailAddresses, websites). Without this parameter, only basic party info (id, type, name, pictureURL) is returned.
integer
required
The unique ID of the user 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: CAPSULE_CRM_LIST_ACTIVITY_TYPE_ICONSTool to list available activity type icons in Capsule CRM. Use when you need to retrieve the set of icons available for categorizing activities or when creating/updating activity types. Returns system and custom icons with their identifiers, display names, and order.

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: CAPSULE_CRM_LIST_ACTIVITY_TYPESTool to list all activity types on the Capsule account. Use when you need to retrieve available activity types for categorizing activities or understanding what activity classifications are available in the CRM.

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: CAPSULE_CRM_LIST_BOARDSTool to list all boards on the Capsule CRM account. Use when you need to fetch all boards to view their names, descriptions, and metadata.

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: CAPSULE_CRM_LIST_BOARD_STAGESList stages associated with a board in Capsule CRM, with optional status filtering and pagination. Each request retrieves one page of stages.

Input Parameters

integer
Pagination control. Starts at 1. Default: 1.
string ("active" | "archived" | "all")
Status filter for stages.
integer
required
The unique identifier of the board.
integer
Results per page (1-100 range). Default: 50.

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: CAPSULE_CRM_LIST_CATEGORIESTool to list all task categories on the Capsule account. Use when you need to retrieve available categories for tasks or filter tasks by category.

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: CAPSULE_CRM_LIST_COUNTRIESTool to list all countries on the Capsule CRM account. Returns ISO country codes (alpha2, alpha3, numeric) and country names. Use when you need to reference valid country codes for addresses or other location-based data.

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: CAPSULE_CRM_LIST_CURRENCIESTool to list all available currencies on the Capsule account. Returns ISO 4217 currency codes with their symbols and names. Use when you need to display currency options or validate currency codes for opportunities.

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: CAPSULE_CRM_LIST_CUSTOM_FIELD_DEFINITIONSTool to list all custom field definitions for parties, opportunities, or projects (kases). Use when you need to discover what custom fields are available for a specific entity type.

Input Parameters

string ("parties" | "opportunities" | "kases")
required
Entity type to retrieve field definitions for. Must be ‘parties’, ‘opportunities’, or ‘kases’ (projects).

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: CAPSULE_CRM_LIST_DELETED_OPPORTUNITIESTool to list opportunities deleted or restricted since a given date. Use when you need to identify recently deleted or restricted opportunities.

Input Parameters

string
required
ISO8601 date/time. Returns only opportunities that have been deleted or made restricted after this date. This parameter is required.

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: CAPSULE_CRM_LIST_DELETED_PARTIESRetrieve parties deleted since a given date, with restricted parties also returned when present. Use to sync deletions and identify restricted records.

Input Parameters

string
required
The since date is required to return only entities that have been deleted after this date. Must be in ISO8601 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: CAPSULE_CRM_LIST_DELETED_PROJECTSTool to list projects deleted or restricted since a given date. Use when you need to identify recently deleted or restricted projects.

Input Parameters

string
required
ISO8601 date/time. Returns only projects that have been deleted or made restricted after this date. This parameter is required.

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: CAPSULE_CRM_LIST_ENTITY_ENTRIESList a page of entries, including notes, emails, and tasks, for a specific party, opportunity, or project. Pages can be requested to retrieve associated activity entries.

Input Parameters

integer
Page number for pagination. Default: 1
array
List of additional data to embed in the response. Allowed values: ‘party’ (linked party), ‘kase’ (linked project), ‘opportunity’ (linked opportunity), ‘creator’ (user who created entry), ‘activityType’ (activity classification).
string ("parties" | "opportunities" | "kases")
required
Entity type to list entries for: ‘parties’ (contacts), ‘opportunities’ (deals), or ‘kases’ (projects)
integer
Number of entries to return per page (1-50). Default: 50
integer
required
ID of the party, opportunity, or project to list entries 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: CAPSULE_CRM_LIST_ENTITY_TAGSTool to list all tag definitions for a specific entity type (parties, opportunities, or kases). Use when you need to retrieve available tags that can be applied to entities.

Input Parameters

string ("parties" | "opportunities" | "kases")
required
Entity type to list tags for. Must be one of: ‘parties’ (contacts), ‘opportunities’ (sales opportunities), or ‘kases’ (projects).

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: CAPSULE_CRM_LIST_ENTITY_TRACKSList a page of tracks applied to a specific opportunity or project, optionally including their tasks. Pages can be requested to retrieve associated tracks.

Input Parameters

integer
The page of results to return. Default: 1.
array
Array of strings to include related data. Allowed value: ‘task’ to include tasks associated with the track.
string ("opportunities" | "kases")
required
Entity type - must be ‘opportunities’ or ‘kases’ (projects)
integer
Number of results per page (1-100). Default: 50.
integer
required
The unique identifier for the specific opportunity or project

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: CAPSULE_CRM_LIST_ENTRIES_BY_DATETool to list notes, emails, and completed party tasks in descending order by entry date. Use when you need the most recent entries first after authenticating.

Input Parameters

integer
The page of results to return. Default: 1
array
List of additional data to embed in the response. Allowed values: ‘party’ (linked party), ‘kase’ (linked project), ‘opportunity’ (linked opportunity), ‘creator’ (user who created entry), ‘activityType’ (activity classification).
integer
The number of entries to return per page (1-100). Default: 50

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: CAPSULE_CRM_LIST_GOALSTool to list all goals on the Capsule account. Use when you need to retrieve goals with pagination support.

Input Parameters

integer
The page of results to return. Default: 1.
integer
Number of goals per page (1-100). Default: 50.

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: CAPSULE_CRM_LIST_LOST_REASONSTool to list all lost reasons on the Capsule account. Use when you need to retrieve available reasons for marking opportunities as lost.

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: CAPSULE_CRM_LIST_MILESTONESList milestones on the Capsule account for pipelines or opportunities, with page and page-size controls.

Input Parameters

integer
The page of results to return. Default: 1.
integer
Number of milestones per page (1-100). Default: 50.

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: CAPSULE_CRM_LIST_OPPORTUNITIESTool to list all opportunities from Capsule CRM with pagination and filtering. Use when you need to retrieve sales opportunities with optional filters for date changes or embed additional data like tags, custom fields, party details, or milestones.

Input Parameters

integer
The page of results to return (starts at 1). Default: 1.
array
List of additional data to embed. Allowed values: ‘tags’, ‘fields’, ‘party’, ‘milestone’, ‘missingImportantFields’.
string
Include only opportunities changed after this date (ISO8601 format, e.g., ‘2024-01-01T00:00:00Z’).
integer
Number of opportunities per page (1-100). Default: 50.

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: CAPSULE_CRM_LIST_OPPORTUNITY_PARTIESTool to list additional parties associated with an opportunity in Capsule CRM. Use when you need to retrieve contacts related to a specific opportunity.

Input Parameters

integer
Page number of results to return (>=1). Default: 1.
array
List of additional data to embed. Allowed values: ‘tags’, ‘fields’, ‘organisation’, ‘missingImportantFields’.
integer
Number of parties per page (1-100). Default: 50.
integer
required
The unique identifier of the opportunity to list parties 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: CAPSULE_CRM_LIST_OPPORTUNITY_PROJECTSList a page of projects (cases) associated with a specific opportunity in Capsule CRM.

Input Parameters

integer
The page of results to return (starts at 1). Default: 1.
string
Comma-separated list of additional data to embed. Options: ‘tags’, ‘fields’, ‘party’, ‘opportunity’, ‘missingImportantFields’.
integer
Number of projects per page (1-100). Default: 50.
integer
required
The unique identifier of the opportunity to retrieve projects 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: CAPSULE_CRM_LIST_ORG_EMPLOYEESList a page of employees linked to a specific organisation in Capsule CRM.

Input Parameters

integer
Page number of results to return, must be at least 1
array
List of additional data to include; allowed values: ‘tags’, ‘fields’, ‘organisation’, ‘missingImportantFields’
integer
Number of results per page, must be between 1 and 100
integer
required
ID of the organisation (party) to list employees 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: CAPSULE_CRM_LIST_PARTIESList a page of parties (contacts) on the account, with an optional changed-since filter or embedded related data.

Input Parameters

integer
Page number of results to return (>=1). Default: 1.
array
Comma-separated list of additional data to embed. Allowed values: ‘tags’, ‘fields’, ‘organisation’, ‘missingImportantFields’.
string
Include only parties changed after this date (ISO8601 format).
integer
Number of parties per page (1-100). Default: 50.

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: CAPSULE_CRM_LIST_PARTY_OPPORTUNITIESList a page of opportunities associated with a specific party in Capsule CRM.

Input Parameters

integer
The page of results to return (starts at 1). Default: 1.
integer
required
The ID of the party to list opportunities for. Required.
integer
Number of opportunities per page (1-100). Default: 50.

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: CAPSULE_CRM_LIST_PARTY_PROJECTSList a page of projects associated with a specific party in Capsule CRM. Use pagination to retrieve projects linked to a contact or organisation.

Input Parameters

integer
The page of results to return (starts at 1). Default: 1.
string
Comma-separated list of additional data to embed. Options: ‘tags’, ‘fields’, ‘party’, ‘opportunity’, ‘missingImportantFields’.
integer
required
The unique identifier of the party to retrieve projects for.
integer
Number of projects per page (1-100). Default: 50.

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: CAPSULE_CRM_LIST_PIPELINE_MILESTONESList a page of milestones for a specific pipeline in Capsule CRM, including their names, completion status, and probability. Use pagination to retrieve further milestones.

Input Parameters

integer
The page of results to return. Default: 1.
integer
Number of milestones per page (1-100). Default: 50.
integer
required
The unique identifier of the pipeline.

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: CAPSULE_CRM_LIST_PIPELINESList a page of sales pipelines on the Capsule account. Pipelines contain milestones that track opportunity progress; use this to retrieve available pipelines or reference their IDs, with pagination for further results.

Input Parameters

integer
The page of results to return. Default: 1.
integer
Number of pipelines per page (1-100). Default: 50.
boolean
Include archived/deleted pipelines in results. Default: false.

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: CAPSULE_CRM_LIST_PROJECT_PARTIESList a page of parties associated with a specific project in Capsule CRM, with optional embedded data. Use pagination to retrieve further contacts.

Input Parameters

integer
The page of results to return (starts at 1). Default: 1.
array
Request additional data to embed. Allowed values: ‘tags’, ‘fields’, ‘organisation’, ‘missingImportantFields’.
integer
Number of parties per page (1-100). Default: 50.
integer
required
The unique identifier of the project to retrieve parties 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: CAPSULE_CRM_LIST_PROJECTSList projects (cases) from Capsule CRM with pagination and filtering by status, search terms, and date modified. The tool can request embedded data such as tags, party details, and opportunities.

Input Parameters

integer
The page of results to return (starts at 1). Default: 1.
string
Comma-separated list of additional data to embed. Options: ‘tags’, ‘fields’, ‘party’, ‘opportunity’, ‘missingImportantFields’.
string
ISO8601 date/datetime to filter projects modified after this date (e.g., ‘2024-01-01T00:00:00Z’).
Search term to filter project names or descriptions.
string
Filter by project status (e.g., ‘OPEN’, ‘CLOSED’).
integer
Number of projects per page (1-100). Default: 50.

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: CAPSULE_CRM_LIST_REST_HOOKSTool to list all REST hook subscriptions on the Capsule CRM account. REST hooks are webhook subscriptions that notify your application of events like party/opportunity/project created/updated/deleted. Use when you need to view existing webhook configurations or audit active subscriptions.

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: CAPSULE_CRM_LIST_SITETool to retrieve site (account) information for the authenticated Capsule CRM account. Returns the site URL, subdomain, and organization name. Use this when you need to identify which Capsule account is being accessed or retrieve basic account details.

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: CAPSULE_CRM_LIST_STAGESTool to list all stages on the Capsule CRM account. Use when you need to retrieve stages across all boards with optional status filtering and pagination.

Input Parameters

integer
Specifies which results page to retrieve. Default: 1.
string ("active" | "archived" | "all")
Status filter for stages.
integer
Sets the number of results per page (1-100 range). Default: 50.
boolean
When true, returns stages residing on archived boards. Default is false.

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: CAPSULE_CRM_LIST_TASKSTool to list tasks on the Capsule account. Use when you need to retrieve tasks with filters or embedded related data.

Input Parameters

integer
The page of results to return. Default: 1.
array
Comma-separated list of additional data to embed. Allowed values: ‘party’, ‘opportunity’, ‘kase’, ‘owner’, ‘nextTask’. WARNING: Embedding ‘owner’ or ‘party’ returns full nested objects with 15+ fields each, significantly increasing response size. For simple filtering by owner name, consider using the API without embed and filtering results client-side.
array
Comma-separated list of task statuses to filter by. Allowed values: ‘open’, ‘completed’, ‘pending’.
integer
Number of tasks per page (1-100). Default: 50.

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: CAPSULE_CRM_LIST_TEAMSList teams on the Capsule CRM account, returning their IDs, names, and creation and update timestamps.

Input Parameters

string
Additional data to include in the response. Use ‘memberships’ to include team members information.

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: CAPSULE_CRM_LIST_TITLESTool to list all custom person titles on the Capsule account. Returns title IDs and text values. Use when you need to retrieve available title options for person records or reference title IDs for other operations.

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: CAPSULE_CRM_LIST_TRACK_DEFINITIONSList a page of track definitions on the Capsule account, including track templates for opportunities or projects. Supports page and page-size selection.

Input Parameters

integer
The page of results to return. Default: 1.
integer
Number of track definitions per page (1-100). Default: 50.

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: CAPSULE_CRM_LIST_USERSList all users on the Capsule CRM account. Returns user details including id, username, name, locale, currency, status, timezone, lastLoginAt, and taskReminder settings. Optionally embed full party details (addresses, phone numbers, emails) using the embed parameter. Use this for user management, auditing, or when you need to reference user IDs for other operations.

Input Parameters

array
List of additional data to embed. Use [‘party’] to include full party details (createdAt, updatedAt, owner, team, addresses, phoneNumbers, emailAddresses, websites). Without this parameter, only basic party info (id, type, name, pictureURL) is returned.

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: CAPSULE_CRM_RESTORE_BOARDTool to restore a deleted board in Capsule CRM. Use when you need to recover a previously deleted board. Requires Administrator role.

Input Parameters

integer
required
The unique identifier (integer ID) of the board to restore.

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: CAPSULE_CRM_RUN_FILTER_QUERYTool to run structured filter queries on parties, opportunities or kases. Use when you need to retrieve entities matching specific filter conditions.

Input Parameters

integer
Page of results to return. Default is 1.
array
Additional data to include, comma-separated list. Supported values vary by entity.
string ("parties" | "opportunities" | "kases")
required
Entity type to filter: parties, opportunities, or kases (projects).
object
required
Filter object containing conditions and optional sort order.
integer
Number of entities per page (1-100). Default is 50.

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: CAPSULE_CRM_SEARCH_OPPORTUNITIESTool to search for opportunities in Capsule CRM by query string. Use when you need to find specific opportunities by searching their names or descriptions.

Input Parameters

string
required
The search query string to match against opportunity names and descriptions.
integer
The page of results to return (starts at 1). Default: 1.
integer
Number of opportunities per page (1-100). Default: 50.

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: CAPSULE_CRM_SEARCH_PARTIESTool to search for parties (contacts/organisations) in Capsule CRM by query string. Use when you need to find specific parties by searching their names, contact info, or tags.

Input Parameters

string
required
The search query string to match against party names, contact info, and tags.
integer
The page of results to return (starts at 1). Default: 1.
integer
Number of parties per page (1-100). Default: 50.

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: CAPSULE_CRM_SEARCH_PROJECTSTool to search for projects (cases) in Capsule CRM by query string. Use when you need to find specific projects by searching their names or descriptions.

Input Parameters

string
required
The search query string to match against project names and descriptions.
integer
The page of results to return (starts at 1). Default: 1.
integer
Number of projects per page (1-100). Default: 50.

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: CAPSULE_CRM_UPDATE_BOARDTool to update an existing board in Capsule CRM. Use when you need to modify the name or description of a board. Requires Administrator role on the Capsule account.

Input Parameters

object
required
Board object containing fields to update
integer
required
The ID of the board 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: CAPSULE_CRM_UPDATE_CATEGORYTool to update an existing category in Capsule CRM. Use when you need to modify the name or color of a category.

Input Parameters

object
required
Category object with fields to update (name and/or colour)
integer
required
The ID of the category 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: CAPSULE_CRM_UPDATE_CUSTOM_FIELD_DEFINITIONUpdate the name of a custom field definition for parties, opportunities, or projects in Capsule CRM, optionally changing its data tag association.

Input Parameters

string ("parties" | "opportunities" | "kases")
required
The entity type to update the custom field definition for. Must be one of: parties, opportunities, or kases.
integer
required
The unique identifier (integer ID) of the custom field definition to update.
object
required
Field definition object containing the updated name and optionally a data tag

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: CAPSULE_CRM_UPDATE_ENTITY_TAGTool to update an existing tag for an entity type (parties, opportunities, or kases) in Capsule CRM. Use when you need to modify the name of a tag.

Input Parameters

object
required
Tag object with fields to update (name)
string ("parties" | "opportunities" | "kases")
required
The entity type to update the tag for. Must be one of: ‘parties’, ‘opportunities’, or ‘kases’.
integer
required
The unique numeric identifier of the tag 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: CAPSULE_CRM_UPDATE_ENTRYTool to update an existing entry (note, email, or task) in Capsule CRM. Use when you need to modify the content of an entry or manage its attachments.

Input Parameters

integer
required
The unique ID of the entry to update
object
required
Fields to update on the entry object

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: CAPSULE_CRM_UPDATE_LOST_REASONUpdate an existing Capsule CRM lost reason by ID, supplying both its name and conversion tracking setting.

Input Parameters

object
required
Lost reason object containing name and includedForConversion fields
integer
required
The ID of the lost reason 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: CAPSULE_CRM_UPDATE_MILESTONETool to update an existing milestone in Capsule CRM. Use when you need to modify the name, description, or probability of a milestone stage in the sales pipeline.

Input Parameters

object
required
Milestone object containing fields to update
integer
required
The unique identifier of the milestone 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: CAPSULE_CRM_UPDATE_OPPORTUNITYTool to update an existing opportunity in Capsule CRM. Use when you need to modify details such as name, value, milestone, probability, or custom fields after confirming the opportunity ID.

Input Parameters

object
required
Fields to update on the opportunity object
integer
required
Unique ID of the opportunity 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: CAPSULE_CRM_UPDATE_PARTYTool to update an existing person or organisation (Party) in Capsule CRM. Use when you need to modify specific fields of a party after confirming its ID. Example: “Update party 11587 to remove phone number 12136 and add a new work email.”

Input Parameters

array
Additional data to embed in response: tags, fields, organisation, or missingImportantFields
object
required
Fields to update on the party object
integer
required
Unique ID of the party 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: CAPSULE_CRM_UPDATE_PIPELINETool to update an existing pipeline in Capsule CRM. Use when you need to modify the name or description of a pipeline.

Input Parameters

object
required
Pipeline object containing fields to update. Only included fields are modified.
integer
required
The unique identifier of the pipeline 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: CAPSULE_CRM_UPDATE_PROJECTTool to update an existing project (case) in Capsule CRM. Use when you need to modify project details such as name, description, status, or custom fields after confirming the project ID.

Input Parameters

object
required
Fields to update on the project object
string
Comma-separated list of additional data to embed. Options: ‘tags’, ‘fields’, ‘party’, ‘opportunity’, ‘missingImportantFields’.
integer
required
Unique ID of the project 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: CAPSULE_CRM_UPDATE_STAGETool to update an existing stage in Capsule CRM. Use when you need to modify the name, description, or display order of a stage within a board. Requires Administrator role on the Capsule account.

Input Parameters

object
required
Stage object containing updatable fields
integer
required
The identifier of the stage 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: CAPSULE_CRM_UPDATE_TASKTool to update an existing task in Capsule CRM. Use when you need to modify task details, change status to completed, or update due dates.

Input Parameters

object
required
Fields to update on the task object
integer
required
The unique ID of the task 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: CAPSULE_CRM_UPDATE_TRACKTool to update an existing track in Capsule CRM. Use when you need to modify the description or trackDateOn of a track instance. Only description and trackDateOn can be modified.

Input Parameters

array
Additional data to embed in response. Use ‘task’ to include tasks on the track.
object
required
Track object containing fields to update
integer
required
The unique identifier of the track 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: CAPSULE_CRM_UPDATE_TRACK_DEFINITIONTool to update an existing track definition in Capsule CRM. Use when you need to modify the description or manage task definitions within a track.

Input Parameters

object
required
Track definition object with fields to update (description and/or taskDefinitions)
integer
required
The ID of the track definition 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: CAPSULE_CRM_UPDATE_USERTool to update an existing user in Capsule CRM. Use when you need to modify user preferences such as task reminders, locale, currency, timezone, or email settings.

Input Parameters

object
required
User fields to update
string
Comma-separated values to include additional data. Supported value: ‘party’ to include full party details
integer
required
The unique ID of the user 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: CAPSULE_CRM_UPLOAD_ATTACHMENTTool to upload an attachment to Capsule CRM. Returns a token that can be used to associate the attachment with entries when creating or updating them. Maximum file size is 25MB.

Input Parameters

object
required
File to upload. Maximum file size is 25MB.

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