Skip to main content
Forcemanager logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 20
  • Triggers: 0
  • Slug: FORCEMANAGER
  • Version: 20261101_00

Tools

Slug: FORCEMANAGER_DELETE_ACTIVITYDelete an existing activity by ID. Tries multiple base hosts and path variants to maximize compatibility across environments and gateways.

Input Parameters

integer
required
Activity identifier (positive integer)
integer
ForceManager API version to use (sent via X-FM-API-Version header)

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: FORCEMANAGER_DELETE_COMPANYTool to delete a company by its ForceManager ID. Use when you need to remove an existing company from the system.

Input Parameters

integer
required
Company identifier (positive integer)
integer
ForceManager API version to use (sent via X-FM-API-Version header)

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: FORCEMANAGER_DELETE_CONTACTPermanently deletes a contact from ForceManager by its unique ID. This action removes the specified contact and all associated data. The operation is irreversible. The action automatically tries multiple API endpoint combinations to ensure compatibility across different ForceManager deployments and configurations. Returns the HTTP status code and any response message from the API. A successful deletion typically returns a 200 status code.

Input Parameters

integer
required
The unique ID of the contact to delete. Must be a positive integer that represents an existing contact in ForceManager.
integer
Optional API version number to use for this request. If specified, it will be sent in the X-FM-API-Version header. Leave empty to use the default API version.

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: FORCEMANAGER_DELETE_SALES_ORDERDelete a sales order by ID using ForceManager REST API. Tries multiple base hosts and path variants to maximize compatibility across environments. Accepts successful HTTP status codes (< 300) even when the response is non-JSON, capturing response text.

Input Parameters

integer
required
The unique identifier of the sales order to delete
integer
ForceManager API version to use. If specified, sends X-FM-API-Version header with the request

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: FORCEMANAGER_DELETE_SALES_ORDER_LINEDelete a specific ForceManager sales order line by its positive integer ID. An optional API version can be specified for the request.

Input Parameters

integer
required
The unique identifier of the sales order line to delete. Must be a positive integer representing an existing sales order line ID.
integer
ForceManager API version to use for this request. If specified, sends X-FM-API-Version header. Leave unset to use the default API version.

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: FORCEMANAGER_DELETE_VALUEDelete a master-data value (Z_ table) by ID using ForceManager REST API. Tries multiple base hosts and path variants to maximize compatibility across environments. Accepts successful HTTP status codes (< 300) even when the response is HTML instead of JSON, capturing the response text as a message. Also retries sending authentication headers as query parameters on HTTP 401 as some gateways expect them in query string.

Input Parameters

integer
required
Identifier of the master-data value to delete
integer
Optional ForceManager API version to use (sent via X-FM-API-Version)
string
required
Name of the Z_ master data table containing the value (e.g., Z_Test)

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: FORCEMANAGER_DELETE_VIEWDelete a saved view (custom filter) by its ID. Views in ForceManager are saved filter configurations that users create to quickly access filtered lists of entities (accounts, activities, opportunities, etc.). This action permanently removes a view that the authenticated user has permission to delete. Use Cases: - Remove outdated or unused custom filters - Clean up views after organizational changes - Programmatically manage view lifecycle Requirements: - Valid view ID that exists in the system - Appropriate permissions to delete the view - The view must be owned by or shared with the authenticated user Note: This action tries multiple ForceManager API endpoints to maximize compatibility across different deployment environments and API versions.

Input Parameters

string
required
ID of the saved view (custom filter) to delete. A view in ForceManager represents a saved filter configuration for entities like accounts, activities, or opportunities. The ID must match an existing view that the authenticated user has permission to delete.
integer
ForceManager API version to use (sent via X-FM-API-Version header). Optional - defaults to the API’s default version if not specified.

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: FORCEMANAGER_GET_ACTIVITYRetrieves a single activity by its ID from ForceManager CRM. Use this tool when you need to: - Fetch details of a specific activity by its ID - Check if an activity exists - Retrieve activity data including comments, dates, linked contacts/accounts, and location info The action attempts multiple ForceManager API endpoints to ensure compatibility across different API versions and deployment configurations. Returns found=False if the activity does not exist or cannot be retrieved. Authentication is handled automatically via headers from the connected account.

Input Parameters

string
required
The unique identifier of the activity to retrieve. Accepts numeric IDs (e.g., ‘1’, ‘12345’) or alphanumeric external IDs (e.g., ‘abc123’). This is passed as a path parameter in the API request.
integer
ForceManager API version to use. If not specified, the API will use the default version. Sent via X-FM-API-Version header.

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: FORCEMANAGER_GET_COMPANYRetrieve a company by ID from ForceManager, including contact details and custom fields when returned. Returns an entity and a found indicator; found=False can also result from an unsuccessful retrieval and does not confirm that the company is absent.

Input Parameters

string
required
The unique identifier of the company to retrieve. Can be a numeric ID (e.g., ‘5000’) or alphanumeric external ID
integer
Optional API version number to use (sent via X-FM-API-Version header). Leave unset to use the default version

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: FORCEMANAGER_GET_INTERNAL_IDRetrieve ForceManager internal ID mappings for an external ID and entity type, with optional pagination and API version. Non-JSON responses and HTTP errors can yield empty results; network failures across all attempted endpoints raise an error.

Input Parameters

integer
Zero-based page index to request (sent as X-FM-Page header)
string ("Company" | "User" | "Offer" | "Product" | "Contact" | "Activity" | "Schedule")
required
Entity type to search for internal ID mapping. Use one of the predefined entity types: Company, User, Offer, Product, Contact, Activity, or Schedule.
string
required
External identifier of the entity in your system. Some API examples use ‘externalid’ (lowercase); this action sends both for compatibility.
integer
ForceManager API version to use (sent as X-FM-API-Version header)

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: FORCEMANAGER_GET_PRODUCTRetrieve a product by ID from ForceManager, including details such as price, category and custom fields when returned. Returns an entity and a found indicator; found=False can also result from an unsuccessful retrieval and does not confirm that the product is absent.

Input Parameters

integer
required
Identifier of the product to retrieve (positive integer)
integer
ForceManager API version to use (sent via X-FM-API-Version header)

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: FORCEMANAGER_GET_SALES_ORDER_LINERetrieves a single sales order line by ID from ForceManager. A sales order line represents a product item within a sales order, including quantity, pricing, and discount information. Use this when you need to fetch details about a specific line item in a sales order, such as product information, quantities, prices, or applied discounts.

Input Parameters

string
required
The unique identifier of the sales order line to retrieve (numeric string or integer)
integer
ForceManager API version to use (sent via X-FM-API-Version header). Optional, defaults to API’s default version if not specified.

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: FORCEMANAGER_GET_USERRetrieve a ForceManager user by ID, including profile, contact and permission details when returned. Returns an entity and a found indicator; found=False can also result from an unsuccessful retrieval and does not confirm that the user is absent.

Input Parameters

string
required
User ID to retrieve. Can be a numeric string (e.g., ‘123’) or alphanumeric identifier
integer
ForceManager API version to use (sent via X-FM-API-Version header). Defaults to version 4 if not specified

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: FORCEMANAGER_GET_VIEWRetrieve a saved ForceManager view by ID. Returns view items and their count; if direct retrieval fails, the tool can match the ID against a listed page of views. An empty result does not necessarily mean the view is absent.

Input Parameters

string
required
Unique identifier of the view to retrieve (numeric or alphanumeric string)
integer
ForceManager API version to use (sent via X-FM-API-Version header)

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: FORCEMANAGER_LIST_VIEWSTool to list saved view filters. Use when you need to retrieve saved views for a specific entity (e.g., list views for entity ‘account’).

Input Parameters

string
Advanced search query (SQL-like) applied to views
string
Important-field LIKE filter to match view name
integer
Zero-based page index to request (sent as X-FM-Page header)
string
Important-field LIKE filter to match target entity name
integer
ForceManager API version to use (sent as X-FM-API-Version header)

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: FORCEMANAGER_UPDATE_ACTIVITYTool to update an existing activity by ID. Use when you need to change fields such as comment, date/time, linked entities, or geocode.

Input Parameters

integer
required
Activity identifier (positive integer)
string
External id from third-party system
string
Comments for the activity
boolean
Calculated if geocode exists (read-only, discourage sending)
integer
Linked account id
integer
Linked contact id
boolean
Whether this is a check-in (boolean, sent as ‘True’/‘False’ per FM API)
integer
ForceManager API version to use (sent as X-FM-API-Version header)
string
If is_checkin=True: Standard Checkin | Opportunity | FastCheckin
integer
Sales rep ID (may be read-only)
integer
Linked opportunity id
integer
Activity type id
number
Geocode accuracy
number
Latitude for check-ins
integer
Permission level (1–5)
number
Longitude for check-ins
string
UTC date and time of the activity in ISO 8601 format (YYYY-MM-DDThh:mm:ss)
string
Checkout date-time for check-out activities (ISO 8601 UTC)

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: FORCEMANAGER_UPDATE_COMPANYUpdate Company

Input Parameters

integer
required
Company identifier (positive integer). Must be an existing company ID from your ForceManager account.
string
Fax number
string
Company name
string
Email address
string
Primary phone number
string
External system identifier for integration with other systems
string
Comments or notes about the company
string
Secondary phone number
string
Website URL
string
Postal/ZIP code
string
Primary address line
string
Secondary address line
string
Branch identifier (string ID from ForceManager)
string
City name
string
Country identifier (numeric string or country code)
string
Market segment identifier (string ID from ForceManager)
string
VAT/tax identification number for the company
integer
ForceManager API version to use (sends X-FM-API-Version header)
object
Dictionary of extra custom fields (z_*) to merge into payload
string
Mobile phone number
string
Primary sales representative user ID (string ID from ForceManager)
string
Province or state name
string
Secondary sales representative user ID
string
Third sales representative user ID
string
Fourth sales representative user ID
string
Fifth sales representative user ID
boolean
Whether the company is visible to all users in the organization
string
Account type identifier (string ID from ForceManager)
string
Default product rate/price list identifier
integer
Access permission level (1=lowest to 5=highest)
string
Account status identifier (string ID from ForceManager)
string
Geolocation accuracy radius in meters (e.g., ‘50’, ‘100’)

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: FORCEMANAGER_UPDATE_PRODUCTUpdates an existing product by ID in ForceManager. Use this tool to modify product details such as name, price, cost, description, availability status, category, family, discount limits, and custom fields. The product must already exist - this action does not create new products. At least one field besides ‘id’ must be provided to update.

Input Parameters

integer
required
Product identifier (positive integer)
number
Manufacturing or acquisition cost (in currency units)
string
Product name or model identifier
number
Selling price (in currency units, e.g., 99.99)
string
External ID from third-party system
integer
Product family ID for grouping related products
integer
ForceManager API version to use (sends X-FM-API-Version header)
integer
Category ID to classify the product
string
Product description or additional comment/notes
object
Dictionary of extra custom fields (z_*) to merge into payload
number
Maximum allowed discount percentage (e.g., 15.5 for 15.5%)
boolean
Set to True to mark product as unavailable/out of stock, False to mark as available
integer
Permission level (1–5)

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: FORCEMANAGER_UPDATE_SALES_ORDERUpdate Sales Order

Input Parameters

integer
required
Sales order identifier (positive integer)
integer
Order year
string
Sales order topic
number
Order amount, must be non-negative
string
External identifier
integer
Order number
string
Address line for the order
integer
Rate ID for the order
boolean
Archive flag; True to archive
string
Sales order comments
integer
Branch ID
integer
Sales order status ID
integer
Linked account ID
integer
Linked contact ID
number
First discount value
number
Second discount value
number
Third discount value
number
Fourth discount value
integer
ForceManager API version to use (sends X-FM-API-Version header)
string
Actual closed date (YYYY-MM-DD)
integer
Currency ID
object
Dictionary of extra custom fields (z_*) to merge into payload
integer
Sales representative ID
integer
Linked opportunity ID
string
Expected closing date (YYYY-MM-DD)

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: FORCEMANAGER_UPDATE_SALES_ORDER_LINETool to update sales order line by ID. Use when modifying details of an existing sales order line. Retries with query auth on 401 for proxy-pro host.

Input Parameters

string
required
Identifier of the sales order line to update
number
Unit price before discounts, must be non-negative
integer
Quantity for this line, must be non-negative
number
First discount, must be non-negative
number
Second discount, must be non-negative
number
Third discount, must be non-negative
number
Fourth discount, must be non-negative
string
Identifier of the product for this line
integer
ForceManager API version to use (sends X-FM-API-Version header)
number
Final price after discounts, must be non-negative
object
Additional custom fields (e.g., z_customField) to merge into the payload
string
Identifier of the sales order owning the line

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