> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# ForceManager plugin

> Manage Sage Sales Management v4 CRM records, sales resources, activities, products, orders, users, and reference data.

Use **ForceManager** through Corsair: one client, typed API calls.

ForceManager issues a public and a private API key in ForceAdmin. Store the private key as the account's API key and the public key in its `public_key` field (`pnpm corsair setup --plugin=forcemanager api_key=<private key> public_key=<public key>`, or the two fields on Hub's connect page). The plugin logs in with the pair, sends the session token in X-Session-Key and logs in again when the token expires. Set environment to sandbox to target the documented sandbox host. Calendar create and update (sendNotification emails invitations), user create and update (an active user can take a paid seat) and the generic bulk create and update routes are destructive. The plugin does not manage webhooks or perform the binary upload step returned by document and picture upload-initiation routes.

**What you get:**

* 294 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/forcemanager better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/forcemanager better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/forcemanager better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/forcemanager better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { forcemanager } from '@corsair-dev/forcemanager';

export const corsair = createCorsair({
	plugins: [
		forcemanager(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the ForceManager API key before the first call: `pnpm corsair setup --plugin=forcemanager --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> forcemanager()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'forcemanager',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**`accountAddresses.accountAddressesSchema`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.forcemanager.api.accountAddresses.accountAddressesSchema({});
```

**Create an account address**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.forcemanager.api.accountAddresses.createAccountAddress({
	body: { accountId: 1, address1: 'Main office' },
});
```

See the full list on the [API](https://docs.corsair.dev/plugins/forcemanager/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/forcemanager/api.md)
>
> Every `forcemanager.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.