Forcemanager

Learn how to use Forcemanager with Composio

Overview

SLUG: FORCEMANAGER

Description

ForceManager is a mobile-first CRM designed to enhance sales team productivity by providing real-time insights and streamlined management of customer interactions.

Authentication Details

bearer_token
stringRequired
generic_api_key
stringRequired
generic_secret
stringRequired
generic_id
stringRequired

Connecting to Forcemanager

Create an auth config

Use the dashboard to create an auth config for the Forcemanager toolkit. This allows you to connect multiple Forcemanager accounts to Composio for agents to use.

1

Select App

Navigate to Forcemanager.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Forcemanager Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4forcemanager_auth_config_id = "ac_YOUR_FORCEMANAGER_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Forcemanager for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, forcemanager_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Forcemanager toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Delete Activity

Description

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

Action Parameters

api_version
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Company

Description

Tool to delete a company by its ForceManager ID. Use when you need to remove an existing company from the system.

Action Parameters

api_version
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired
successfull
booleanRequired

Tool Name: Delete Contact

Description

Delete an existing contact by ID. Tries multiple base hosts and path variants to maximize compatibility across environments and gateways.

Action Parameters

api_version
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Sales Order

Description

Delete 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.

Action Parameters

api_version
id
integerRequired

Action Response

data
object
error
successful
booleanRequired
successfull
booleanDefaults to True

Tool Name: Delete Sales Order Line

Description

Delete a sales order line 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.

Action Parameters

api_version
id
integerRequired

Action Response

data
object
error
successful
booleanRequired
successfull
booleanDefaults to True

Tool Name: Delete Master Data Value

Description

Delete 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.

Action Parameters

api_version
id
integerRequired
resourceName
stringRequired

Action Response

data
object
error
successful
booleanRequired
successfull
booleanDefaults to True

Tool Name: Delete View

Description

Delete a saved view by ID. Tries multiple base hosts and path variants to maximize compatibility across environments and gateways.

Action Parameters

api_version
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Activity

Description

Tool to get a single activity by ID. Use when you need to fetch a specific activity. Returns empty entity with found=False on non-JSON HTML or if not found.

Action Parameters

api_version
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Company

Description

Tool to get a single company by ID. Returns the object when JSON is available; otherwise returns an empty payload with found=False to gracefully handle non-JSON HTML responses from app.forcemanager.net.

Action Parameters

api_version
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Internal ID

Description

Tool to retrieve ForceManager internal IDs mapping for a given externalId and entity type. This action calls the documented endpoint /api/internalid with required authentication headers and optional pagination/version headers. It tries multiple base hosts to avoid HTML app shell responses and gracefully handles non-JSON responses and error codes by returning empty results instead of failing the execution.

Action Parameters

api_version
externalId
stringRequired
page
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Product

Description

Tool to get a single product by ID. It tries multiple known ForceManager endpoints and gracefully handles cases where the response is non-JSON by returning an empty payload with found=False. Fallback: if all direct endpoints fail, it will try listing products and filter locally.

Action Parameters

api_version
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Sales Order Line

Description

Tool to get a single sales order line by ID. Use when you need to fetch details of a specific sales order line.

Action Parameters

api_version
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get User

Description

Tool to get a single user by ID. Use when you need to retrieve user details by ID. Returns empty entity with found=False when user not found or non-JSON is returned.

Action Parameters

api_version
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get View

Description

Tool to get a single view by ID. Returns a list with zero or one view object.

Action Parameters

api_version
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Views

Description

Tool to list saved view filters. Use when you need to retrieve saved views for a specific entity (e.g., list views for entity 'account').

Action Parameters

api_version
entity
name
page
q

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Activity

Description

Tool to update an existing activity by ID. Use when you need to change fields such as comment, date/time, linked entities, or geocode.

Action Parameters

account_id
activity_date_time
activity_type_id
api_version
checkin_type
checkout_date_time
comment
contact_id
ext_id
geocode_accuracy
geocode_latitude
geocode_longitude
geocoded
id
integerRequired
is_checkin
opportunity_id
permission_level
sales_rep_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Company

Description

Update Company

Action Parameters

account_status_id
account_type_id
address_1
address_2
api_version
branch_id
city_name
comment
country_id
email
ext_id
extra_fields
fax
geolocalisation_accuracy
id
integerRequired
mobile_phone
name
permission_level
phone
phone_2
postcode
product_rate_id
province_name
sales_rep_2_id
sales_rep_3_id
sales_rep_4_id
sales_rep_5_id
sales_rep_id
segment_id
vat_number
visible_to_all
website

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Product

Description

Tool to update a product by ID in ForceManager. Use when modifying product details.

Action Parameters

api_version
category_id
cost
description
ext_id
extra_fields
family_id
id
integerRequired
max_discount
model
not_available
permission_level
price

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Sales Order

Description

Update Sales Order

Action Parameters

account_id
address
amount
api_version
archived
branch_id
closed_date
closing_date_expected
comments
contact_id
currency_id
discount_1
discount_2
discount_3
discount_4
ext_id
extra_fields
id
integerRequired
number
opportunity_id
rate_id
sales_rep_id
status_id
topic
year

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Sales Order Line

Description

Tool 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.

Action Parameters

api_version
discount_1
discount_2
discount_3
discount_4
extra_fields
final_price
id
Required
price
product_id
quantity
salesorder_id

Action Response

data
objectRequired
error
successful
booleanRequired